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

Class: Aws::Redshift::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon Redshift. To construct a client, you need to configure a :region and :credentials.

redshift = Aws::Redshift::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::Redshift::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::Redshift::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#accept_reserved_node_exchange(options = {}) ⇒ Types::AcceptReservedNodeExchangeOutputMessage

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

Examples:

Request syntax with placeholder values


resp = client.accept_reserved_node_exchange({
  reserved_node_id: "String", # required
  target_reserved_node_offering_id: "String", # required
})

Response structure


resp.exchanged_reserved_node.reserved_node_id #=> String
resp.exchanged_reserved_node.reserved_node_offering_id #=> String
resp.exchanged_reserved_node.node_type #=> String
resp.exchanged_reserved_node.start_time #=> Time
resp.exchanged_reserved_node.duration #=> Integer
resp.exchanged_reserved_node.fixed_price #=> Float
resp.exchanged_reserved_node.usage_price #=> Float
resp.exchanged_reserved_node.currency_code #=> String
resp.exchanged_reserved_node.node_count #=> Integer
resp.exchanged_reserved_node.state #=> String
resp.exchanged_reserved_node.offering_type #=> String
resp.exchanged_reserved_node.recurring_charges #=> Array
resp.exchanged_reserved_node.recurring_charges[0].recurring_charge_amount #=> Float
resp.exchanged_reserved_node.recurring_charges[0].recurring_charge_frequency #=> String
resp.exchanged_reserved_node.reserved_node_offering_type #=> String, one of "Regular", "Upgradable"

Options Hash (options):

  • :reserved_node_id (required, String)

    A string representing the node identifier of the DC1 Reserved Node to be exchanged.

  • :target_reserved_node_offering_id (required, String)

    The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings

Returns:

See Also:

#authorize_cluster_security_group_ingress(options = {}) ⇒ Types::AuthorizeClusterSecurityGroupIngressResult

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.

If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.authorize_cluster_security_group_ingress({
  cluster_security_group_name: "String", # required
  cidrip: "String",
  ec2_security_group_name: "String",
  ec2_security_group_owner_id: "String",
})

Response structure


resp.cluster_security_group.cluster_security_group_name #=> String
resp.cluster_security_group.description #=> String
resp.cluster_security_group.ec2_security_groups #=> Array
resp.cluster_security_group.ec2_security_groups[0].status #=> String
resp.cluster_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
resp.cluster_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cluster_security_group.ec2_security_groups[0].tags #=> Array
resp.cluster_security_group.ec2_security_groups[0].tags[0].key #=> String
resp.cluster_security_group.ec2_security_groups[0].tags[0].value #=> String
resp.cluster_security_group.ip_ranges #=> Array
resp.cluster_security_group.ip_ranges[0].status #=> String
resp.cluster_security_group.ip_ranges[0].cidrip #=> String
resp.cluster_security_group.ip_ranges[0].tags #=> Array
resp.cluster_security_group.ip_ranges[0].tags[0].key #=> String
resp.cluster_security_group.ip_ranges[0].tags[0].value #=> String
resp.cluster_security_group.tags #=> Array
resp.cluster_security_group.tags[0].key #=> String
resp.cluster_security_group.tags[0].value #=> String

Options Hash (options):

  • :cluster_security_group_name (required, String)

    The name of the security group to which the ingress rule is added.

  • :cidrip (String)

    The IP range to be added the Amazon Redshift security group.

  • :ec2_security_group_name (String)

    The EC2 security group to be added the Amazon Redshift security group.

  • :ec2_security_group_owner_id (String)

    The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

    Example: 111122223333

Returns:

See Also:

#authorize_snapshot_access(options = {}) ⇒ Types::AuthorizeSnapshotAccessResult

Authorizes the specified AWS customer account to restore the specified snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.authorize_snapshot_access({
  snapshot_identifier: "String", # required
  snapshot_cluster_identifier: "String",
  account_with_restore_access: "String", # required
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> true/false
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> true/false
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot. #=> String
resp.snapshot.total_backup_size_in_mega_bytes #=> Float
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.source_region #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.restorable_node_types #=> Array
resp.snapshot.restorable_node_types[0] #=> String
resp.snapshot.enhanced_vpc_routing #=> true/false
resp.snapshot.maintenance_track_name #=> String
resp.snapshot.manual_snapshot_retention_period #=> Integer
resp.snapshot.manual_snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time

Options Hash (options):

  • :snapshot_identifier (required, String)

    The identifier of the snapshot the account is authorized to restore.

  • :snapshot_cluster_identifier (String)

    The identifier of the cluster the 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.

  • :account_with_restore_access (required, String)

    The identifier of the AWS customer account authorized to restore the specified snapshot.

    To share a snapshot with AWS support, specify amazon-redshift-support.

Returns:

See Also:

#batch_delete_cluster_snapshots(options = {}) ⇒ Types::BatchDeleteClusterSnapshotsResult

Deletes a set of cluster snapshots.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_cluster_snapshots({
  identifiers: [ # required
    {
      snapshot_identifier: "String", # required
      snapshot_cluster_identifier: "String",
    },
  ],
})

Response structure


resp.resources #=> Array
resp.resources[0] #=> String
resp.errors #=> Array
resp.errors[0].snapshot_identifier #=> String
resp.errors[0].snapshot_cluster_identifier #=> String
resp.errors[0].failure_code #=> String
resp.errors[0].failure_reason #=> String

Options Hash (options):

Returns:

See Also:

#batch_modify_cluster_snapshots(options = {}) ⇒ Types::BatchModifyClusterSnapshotsOutputMessage

Modifies the settings for a set of cluster snapshots.

Examples:

Request syntax with placeholder values


resp = client.batch_modify_cluster_snapshots({
  snapshot_identifier_list: ["String"], # required
  manual_snapshot_retention_period: 1,
  force: false,
})

Response structure


resp.resources #=> Array
resp.resources[0] #=> String
resp.errors #=> Array
resp.errors[0].snapshot_identifier #=> String
resp.errors[0].snapshot_cluster_identifier #=> String
resp.errors[0].failure_code #=> String
resp.errors[0].failure_reason #=> String

Options Hash (options):

  • :snapshot_identifier_list (required, Array<String>)

    A list of snapshot identifiers you want to modify.

  • :manual_snapshot_retention_period (Integer)

    The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

    The number must be either -1 or an integer between 1 and 3,653.

    If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

  • :force (Boolean)

    A boolean value indicating whether to override an exception if the retention period has passed.

Returns:

See Also:

#cancel_resize(options = {}) ⇒ Types::ResizeProgressMessage

Cancels a resize operation for a cluster.

Examples:

Request syntax with placeholder values


resp = client.cancel_resize({
  cluster_identifier: "String", # required
})

Response structure


resp.target_node_type #=> String
resp.target_number_of_nodes #=> Integer
resp.target_cluster_type #=> String
resp.status #=> String
resp.import_tables_completed #=> Array
resp.import_tables_completed[0] #=> String
resp.import_tables_in_progress #=> Array
resp.import_tables_in_progress[0] #=> String
resp.import_tables_not_started #=> Array
resp.import_tables_not_started[0] #=> String
resp.avg_resize_rate_in_mega_bytes_per_second #=> Float
resp.total_resize_data_in_mega_bytes #=> Integer
resp.progress_in_mega_bytes #=> Integer
resp.elapsed_time_in_seconds #=> Integer
resp.estimated_time_to_completion_in_seconds #=> Integer
resp.resize_type #=> String
resp.message #=> String
resp.target_encryption_type #=> String
resp.data_transfer_progress_percent #=> Float

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier for the cluster that you want to cancel a resize operation for.

Returns:

See Also:

#copy_cluster_snapshot(options = {}) ⇒ Types::CopyClusterSnapshotResult

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.copy_cluster_snapshot({
  source_snapshot_identifier: "String", # required
  source_snapshot_cluster_identifier: "String",
  target_snapshot_identifier: "String", # required
  manual_snapshot_retention_period: 1,
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> true/false
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> true/false
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot. #=> String
resp.snapshot.total_backup_size_in_mega_bytes #=> Float
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.source_region #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.restorable_node_types #=> Array
resp.snapshot.restorable_node_types[0] #=> String
resp.snapshot.enhanced_vpc_routing #=> true/false
resp.snapshot.maintenance_track_name #=> String
resp.snapshot.manual_snapshot_retention_period #=> Integer
resp.snapshot.manual_snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time

Options Hash (options):

  • :source_snapshot_identifier (required, String)

    The identifier for the source snapshot.

    Constraints:

    • Must be the identifier for a valid automated snapshot whose state is available.

    ^

  • :source_snapshot_cluster_identifier (String)

    The identifier 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.

    Constraints:

    • Must be the identifier for a valid cluster.

    ^

  • :target_snapshot_identifier (required, String)

    The identifier given to the new manual snapshot.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for the AWS account that is making the request.

  • :manual_snapshot_retention_period (Integer)

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

Returns:

See Also:

#create_cluster(options = {}) ⇒ Types::CreateClusterResult

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  db_name: "String",
  cluster_identifier: "String", # required
  cluster_type: "String",
  node_type: "String", # required
  master_username: "String", # required
  master_user_password: "String", # required
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  cluster_subnet_group_name: "String",
  availability_zone: "String",
  preferred_maintenance_window: "String",
  cluster_parameter_group_name: "String",
  automated_snapshot_retention_period: 1,
  manual_snapshot_retention_period: 1,
  port: 1,
  cluster_version: "String",
  allow_version_upgrade: false,
  number_of_nodes: 1,
  publicly_accessible: false,
  encrypted: false,
  hsm_client_certificate_identifier: "String",
  hsm_configuration_identifier: "String",
  elastic_ip: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  kms_key_id: "String",
  enhanced_vpc_routing: false,
  additional_info: "String",
  iam_roles: ["String"],
  maintenance_track_name: "String",
  snapshot_schedule_identifier: "String",
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :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. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

    Default: dev

    Constraints:

    • Must contain 1 to 64 alphanumeric characters.

    • Must contain only lowercase letters.

    • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

  • :cluster_identifier (required, 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. The identifier also appears in the Amazon Redshift console.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

    Example: myexamplecluster

  • :cluster_type (String)

    The type of the cluster. When cluster type is specified as

    • single-node, the NumberOfNodes parameter is not required.

    • multi-node, the NumberOfNodes parameter is required.

    Valid Values: multi-node | single-node

    Default: multi-node

  • :node_type (required, String)

    The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

    Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

  • :master_username (required, String)

    The user name associated with the master user account for the cluster that is being created.

    Constraints:

    • Must be 1 - 128 alphanumeric characters. The user name can\'t be PUBLIC.

    • First character must be a letter.

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

  • :master_user_password (required, String)

    The password associated with the master user account for the cluster that is being created.

    Constraints:

    • Must be between 8 and 64 characters in length.

    • Must contain at least one uppercase letter.

    • Must contain at least one lowercase letter.

    • Must contain one number.

    • Can be any printable ASCII character (ASCII code 33 to 126) except \' (single quote), \" (double quote), \, /, @, or space.

  • :cluster_security_groups (Array<String>)

    A list of security groups to be associated with this cluster.

    Default: The default cluster security group for Amazon Redshift.

  • :vpc_security_group_ids (Array<String>)

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Default: The default VPC security group is associated with the cluster.

  • :cluster_subnet_group_name (String)

    The name of a cluster subnet group to be associated with this cluster.

    If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

  • :availability_zone (String)

    The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

    Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

    Example: us-east-2d

    Constraint: The specified Availability Zone must be in the same region as the current endpoint.

  • :preferred_maintenance_window (String)

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Minimum 30-minute window.

  • :cluster_parameter_group_name (String)

    The name of the parameter group to be associated with this cluster.

    Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

  • :automated_snapshot_retention_period (Integer)

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    Default: 1

    Constraints: Must be a value from 0 to 35.

  • :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.

    The value must be either -1 or an integer between 1 and 3,653.

  • :port (Integer)

    The port number on which the cluster accepts incoming connections.

    The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

    Default: 5439

    Valid Values: 1150-65535

  • :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.

    Constraints: Only version 1.0 is currently available.

    Example: 1.0

  • :allow_version_upgrade (Boolean)

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

    When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

    Default: true

  • :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.

    For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

    If you don\'t specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

    Default: 1

    Constraints: Value must be at least 1 and no more than 100.

  • :publicly_accessible (Boolean)

    If true, the cluster can be accessed from a public network.

  • :encrypted (Boolean)

    If true, the data in the cluster is encrypted at rest.

    Default: false

  • :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.

  • :elastic_ip (String)

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

  • :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.

  • :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.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

  • :additional_info (String)

    Reserved.

  • :iam_roles (Array<String>)

    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 10 IAM roles in a single request.

    A cluster can have up to 10 IAM roles associated with it at any time.

  • :maintenance_track_name (String)

    An optional parameter for the name of the maintenance track for the cluster. If you don\'t provide a maintenance track name, the cluster is assigned to the current track.

  • :snapshot_schedule_identifier (String)

    A unique identifier for the snapshot schedule.

Returns:

See Also:

#create_cluster_parameter_group(options = {}) ⇒ Types::CreateClusterParameterGroupResult

Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_cluster_parameter_group({
  parameter_group_name: "String", # required
  parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.cluster_parameter_group.parameter_group_name #=> String
resp.cluster_parameter_group.parameter_group_family #=> String
resp.cluster_parameter_group.description #=> String
resp.cluster_parameter_group.tags #=> Array
resp.cluster_parameter_group.tags[0].key #=> String
resp.cluster_parameter_group.tags[0].value #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the cluster parameter group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique withing your AWS account.

    This value is stored as a lower-case string.

  • :parameter_group_family (required, String)

    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

    To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".

  • :description (required, String)

    A description of the parameter group.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_cluster_security_group(options = {}) ⇒ Types::CreateClusterSecurityGroupResult

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_cluster_security_group({
  cluster_security_group_name: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.cluster_security_group.cluster_security_group_name #=> String
resp.cluster_security_group.description #=> String
resp.cluster_security_group.ec2_security_groups #=> Array
resp.cluster_security_group.ec2_security_groups[0].status #=> String
resp.cluster_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
resp.cluster_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cluster_security_group.ec2_security_groups[0].tags #=> Array
resp.cluster_security_group.ec2_security_groups[0].tags[0].key #=> String
resp.cluster_security_group.ec2_security_groups[0].tags[0].value #=> String
resp.cluster_security_group.ip_ranges #=> Array
resp.cluster_security_group.ip_ranges[0].status #=> String
resp.cluster_security_group.ip_ranges[0].cidrip #=> String
resp.cluster_security_group.ip_ranges[0].tags #=> Array
resp.cluster_security_group.ip_ranges[0].tags[0].key #=> String
resp.cluster_security_group.ip_ranges[0].tags[0].value #=> String
resp.cluster_security_group.tags #=> Array
resp.cluster_security_group.tags[0].key #=> String
resp.cluster_security_group.tags[0].value #=> String

Options Hash (options):

  • :cluster_security_group_name (required, String)

    The name for the security group. Amazon Redshift stores the value as a lowercase string.

    Constraints:

    • Must contain no more than 255 alphanumeric characters or hyphens.

    • Must not be \"Default\".

    • Must be unique for all security groups that are created by your AWS account.

    Example: examplesecuritygroup

  • :description (required, String)

    A description for the security group.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_cluster_snapshot(options = {}) ⇒ Types::CreateClusterSnapshotResult

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_cluster_snapshot({
  snapshot_identifier: "String", # required
  cluster_identifier: "String", # required
  manual_snapshot_retention_period: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> true/false
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> true/false
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot. #=> String
resp.snapshot.total_backup_size_in_mega_bytes #=> Float
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.source_region #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.restorable_node_types #=> Array
resp.snapshot.restorable_node_types[0] #=> String
resp.snapshot.enhanced_vpc_routing #=> true/false
resp.snapshot.maintenance_track_name #=> String
resp.snapshot.manual_snapshot_retention_period #=> Integer
resp.snapshot.manual_snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time

Options Hash (options):

  • :snapshot_identifier (required, String)

    A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.

    Constraints:

    • Cannot be null, empty, or blank

    • Must contain from 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

  • :cluster_identifier (required, String)

    The cluster identifier for which you want a snapshot.

  • :manual_snapshot_retention_period (Integer)

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_cluster_subnet_group(options = {}) ⇒ Types::CreateClusterSubnetGroupResult

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_cluster_subnet_group({
  cluster_subnet_group_name: "String", # required
  description: "String", # required
  subnet_ids: ["String"], # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.cluster_subnet_group.cluster_subnet_group_name #=> String
resp.cluster_subnet_group.description #=> String
resp.cluster_subnet_group.vpc_id #=> String
resp.cluster_subnet_group.subnet_group_status #=> String
resp.cluster_subnet_group.subnets #=> Array
resp.cluster_subnet_group.subnets[0].subnet_identifier #=> String
resp.cluster_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.cluster_subnet_group.subnets[0].subnet_availability_zone.supported_platforms #=> Array
resp.cluster_subnet_group.subnets[0].subnet_availability_zone.supported_platforms[0].name #=> String
resp.cluster_subnet_group.subnets[0].subnet_status #=> String
resp.cluster_subnet_group.tags #=> Array
resp.cluster_subnet_group.tags[0].key #=> String
resp.cluster_subnet_group.tags[0].value #=> String

Options Hash (options):

  • :cluster_subnet_group_name (required, String)

    The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

    Constraints:

    • Must contain no more than 255 alphanumeric characters or hyphens.

    • Must not be \"Default\".

    • Must be unique for all subnet groups that are created by your AWS account.

    Example: examplesubnetgroup

  • :description (required, String)

    A description for the subnet group.

  • :subnet_ids (required, Array<String>)

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_event_subscription(options = {}) ⇒ Types::CreateEventSubscriptionResult

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

Examples:

Request syntax with placeholder values


resp = client.create_event_subscription({
  subscription_name: "String", # required
  sns_topic_arn: "String", # required
  source_type: "String",
  source_ids: ["String"],
  event_categories: ["String"],
  severity: "String",
  enabled: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> Time
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.severity #=> String
resp.event_subscription.enabled #=> true/false
resp.event_subscription.tags #=> Array
resp.event_subscription.tags[0].key #=> String
resp.event_subscription.tags[0].value #=> String

Options Hash (options):

  • :subscription_name (required, String)

    The name of the event subscription to be created.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

  • :sns_topic_arn (required, String)

    The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

  • :source_type (String)

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

  • :source_ids (Array<String>)

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

    Example: my-cluster-1, my-cluster-2

    Example: my-snapshot-20131010

  • :event_categories (Array<String>)

    Specifies the Amazon Redshift event categories to be published by the event notification subscription.

    Values: configuration, management, monitoring, security

  • :severity (String)

    Specifies the Amazon Redshift event severity to be published by the event notification subscription.

    Values: ERROR, INFO

  • :enabled (Boolean)

    A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_hsm_client_certificate(options = {}) ⇒ Types::CreateHsmClientCertificateResult

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_hsm_client_certificate({
  hsm_client_certificate_identifier: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.hsm_client_certificate.hsm_client_certificate_identifier #=> String
resp.hsm_client_certificate.hsm_client_certificate_public_key #=> String
resp.hsm_client_certificate.tags #=> Array
resp.hsm_client_certificate.tags[0].key #=> String
resp.hsm_client_certificate.tags[0].value #=> String

Options Hash (options):

  • :hsm_client_certificate_identifier (required, String)

    The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_hsm_configuration(options = {}) ⇒ Types::CreateHsmConfigurationResult

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_hsm_configuration({
  hsm_configuration_identifier: "String", # required
  description: "String", # required
  hsm_ip_address: "String", # required
  hsm_partition_name: "String", # required
  hsm_partition_password: "String", # required
  hsm_server_public_certificate: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.hsm_configuration.hsm_configuration_identifier #=> String
resp.hsm_configuration.description #=> String
resp.hsm_configuration.hsm_ip_address #=> String
resp.hsm_configuration.hsm_partition_name #=> String
resp.hsm_configuration.tags #=> Array
resp.hsm_configuration.tags[0].key #=> String
resp.hsm_configuration.tags[0].value #=> String

Options Hash (options):

  • :hsm_configuration_identifier (required, String)

    The identifier to be assigned to the new Amazon Redshift HSM configuration.

  • :description (required, String)

    A text description of the HSM configuration to be created.

  • :hsm_ip_address (required, String)

    The IP address that the Amazon Redshift cluster must use to access the HSM.

  • :hsm_partition_name (required, String)

    The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

  • :hsm_partition_password (required, String)

    The password required to access the HSM partition.

  • :hsm_server_public_certificate (required, String)

    The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_scheduled_action(options = {}) ⇒ Types::ScheduledAction

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

Examples:

Request syntax with placeholder values


resp = client.create_scheduled_action({
  scheduled_action_name: "String", # required
  target_action: { # required
    resize_cluster: {
      cluster_identifier: "String", # required
      cluster_type: "String",
      node_type: "String",
      number_of_nodes: 1,
      classic: false,
    },
    pause_cluster: {
      cluster_identifier: "String", # required
    },
    resume_cluster: {
      cluster_identifier: "String", # required
    },
  },
  schedule: "String", # required
  iam_role: "String", # required
  scheduled_action_description: "String",
  start_time: Time.now,
  end_time: Time.now,
  enable: false,
})

Response structure


resp.scheduled_action_name #=> String
resp.target_action.resize_cluster.cluster_identifier #=> String
resp.target_action.resize_cluster.cluster_type #=> String
resp.target_action.resize_cluster.node_type #=> String
resp.target_action.resize_cluster.number_of_nodes #=> Integer
resp.target_action.resize_cluster.classic #=> true/false
resp.target_action.pause_cluster.cluster_identifier #=> String
resp.target_action.resume_cluster.cluster_identifier #=> String
resp.schedule #=> String
resp.iam_role #=> String
resp.scheduled_action_description #=> String
resp.state #=> String, one of "ACTIVE", "DISABLED"
resp.next_invocations #=> Array
resp.next_invocations[0] #=> Time
resp.start_time #=> Time
resp.end_time #=> Time

Options Hash (options):

  • :scheduled_action_name (required, String)

    The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

  • :target_action (required, Types::ScheduledActionType)

    A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

  • :schedule (required, String)

    The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

  • :iam_role (required, String)

    The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

  • :scheduled_action_description (String)

    The description of the scheduled action.

  • :start_time (Time)

    The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

  • :end_time (Time)

    The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

  • :enable (Boolean)

    If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

Returns:

See Also:

#create_snapshot_copy_grant(options = {}) ⇒ Types::CreateSnapshotCopyGrantResult

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.create_snapshot_copy_grant({
  snapshot_copy_grant_name: "String", # required
  kms_key_id: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.snapshot_copy_grant.snapshot_copy_grant_name #=> String
resp.snapshot_copy_grant.kms_key_id #=> String
resp.snapshot_copy_grant.tags #=> Array
resp.snapshot_copy_grant.tags[0].key #=> String
resp.snapshot_copy_grant.tags[0].value #=> String

Options Hash (options):

  • :snapshot_copy_grant_name (required, String)

    The name of the snapshot copy grant. This name must be unique in the region for the AWS account.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

  • :kms_key_id (String)

    The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#create_snapshot_schedule(options = {}) ⇒ Types::SnapshotSchedule

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

Examples:

Request syntax with placeholder values


resp = client.create_snapshot_schedule({
  schedule_definitions: ["String"],
  schedule_identifier: "String",
  schedule_description: "String",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  dry_run: false,
  next_invocations: 1,
})

Response structure


resp.schedule_definitions #=> Array
resp.schedule_definitions[0] #=> String
resp.schedule_identifier #=> String
resp.schedule_description #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_invocations #=> Array
resp.next_invocations[0] #=> Time
resp.associated_cluster_count #=> Integer
resp.associated_clusters #=> Array
resp.associated_clusters[0].cluster_identifier #=> String
resp.associated_clusters[0].schedule_association_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"

Options Hash (options):

  • :schedule_definitions (Array<String>)

    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example \"cron(30 12 *)\" or \"rate(12 hours)\".

  • :schedule_identifier (String)

    A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

  • :schedule_description (String)

    The description of the snapshot schedule.

  • :tags (Array<Types::Tag>)

    An optional set of tags you can use to search for the schedule.

  • :dry_run (Boolean)
  • :next_invocations (Integer)

Returns:

See Also:

#create_tags(options = {}) ⇒ Struct

Adds tags to a cluster.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.

If you specify a key that already exists for the resource, the value for that key will be updated with the new value.

Examples:

Request syntax with placeholder values


resp = client.create_tags({
  resource_name: "String", # required
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Options Hash (options):

  • :resource_name (required, String)

    The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

  • :tags (required, Array<Types::Tag>)

    One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#create_usage_limit(options = {}) ⇒ Types::UsageLimit

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Examples:

Request syntax with placeholder values


resp = client.create_usage_limit({
  cluster_identifier: "String", # required
  feature_type: "spectrum", # required, accepts spectrum, concurrency-scaling
  limit_type: "time", # required, accepts time, data-scanned
  amount: 1, # required
  period: "daily", # accepts daily, weekly, monthly
  breach_action: "log", # accepts log, emit-metric, disable
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure


resp.usage_limit_id #=> String
resp.cluster_identifier #=> String
resp.feature_type #=> String, one of "spectrum", "concurrency-scaling"
resp.limit_type #=> String, one of "time", "data-scanned"
resp.amount #=> Integer
resp.period #=> String, one of "daily", "weekly", "monthly"
resp.breach_action #=> String, one of "log", "emit-metric", "disable"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster that you want to limit usage.

  • :feature_type (required, String)

    The Amazon Redshift feature that you want to limit.

  • :limit_type (required, String)

    The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.

  • :amount (required, Integer)

    The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.

  • :period (String)

    The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

  • :breach_action (String)

    The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

  • :tags (Array<Types::Tag>)

    A list of tag instances.

Returns:

See Also:

#delete_cluster(options = {}) ⇒ Types::DeleteClusterResult

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster({
  cluster_identifier: "String", # required
  skip_final_cluster_snapshot: false,
  final_cluster_snapshot_identifier: "String",
  final_cluster_snapshot_retention_period: 1,
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster to be deleted.

    Constraints:

    • Must contain lowercase characters.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

  • :skip_final_cluster_snapshot (Boolean)

    Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

    The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

    Default: false

  • :final_cluster_snapshot_identifier (String)

    The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

    Constraints:

    • Must be 1 to 255 alphanumeric characters.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

  • :final_cluster_snapshot_retention_period (Integer)

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

Returns:

See Also:

#delete_cluster_parameter_group(options = {}) ⇒ Struct

Deletes a specified Amazon Redshift parameter group.

You cannot delete a parameter group if it is associated with a cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster_parameter_group({
  parameter_group_name: "String", # required
})

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the parameter group to be deleted.

    Constraints:

    • Must be the name of an existing cluster parameter group.

    • Cannot delete a default cluster parameter group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_cluster_security_group(options = {}) ⇒ Struct

Deletes an Amazon Redshift security group.

You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster_security_group({
  cluster_security_group_name: "String", # required
})

Options Hash (options):

  • :cluster_security_group_name (required, String)

    The name of the cluster security group to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_cluster_snapshot(options = {}) ⇒ Types::DeleteClusterSnapshotResult

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster_snapshot({
  snapshot_identifier: "String", # required
  snapshot_cluster_identifier: "String",
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> true/false
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> true/false
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot. #=> String
resp.snapshot.total_backup_size_in_mega_bytes #=> Float
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.source_region #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.restorable_node_types #=> Array
resp.snapshot.restorable_node_types[0] #=> String
resp.snapshot.enhanced_vpc_routing #=> true/false
resp.snapshot.maintenance_track_name #=> String
resp.snapshot.manual_snapshot_retention_period #=> Integer
resp.snapshot.manual_snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time

Options Hash (options):

  • :snapshot_identifier (required, String)

    The unique identifier of the manual snapshot to be deleted.

    Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.

  • :snapshot_cluster_identifier (String)

    The unique identifier of the cluster the 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.

    Constraints: Must be the name of valid cluster.

Returns:

See Also:

#delete_cluster_subnet_group(options = {}) ⇒ Struct

Deletes the specified cluster subnet group.

Examples:

Request syntax with placeholder values


resp = client.delete_cluster_subnet_group({
  cluster_subnet_group_name: "String", # required
})

Options Hash (options):

  • :cluster_subnet_group_name (required, String)

    The name of the cluster subnet group name to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_event_subscription(options = {}) ⇒ Struct

Deletes an Amazon Redshift event notification subscription.

Examples:

Request syntax with placeholder values


resp = client.delete_event_subscription({
  subscription_name: "String", # required
})

Options Hash (options):

  • :subscription_name (required, String)

    The name of the Amazon Redshift event notification subscription to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_hsm_client_certificate(options = {}) ⇒ Struct

Deletes the specified HSM client certificate.

Examples:

Request syntax with placeholder values


resp = client.delete_hsm_client_certificate({
  hsm_client_certificate_identifier: "String", # required
})

Options Hash (options):

  • :hsm_client_certificate_identifier (required, String)

    The identifier of the HSM client certificate to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_hsm_configuration(options = {}) ⇒ Struct

Deletes the specified Amazon Redshift HSM configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_hsm_configuration({
  hsm_configuration_identifier: "String", # required
})

Options Hash (options):

  • :hsm_configuration_identifier (required, String)

    The identifier of the Amazon Redshift HSM configuration to be deleted.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_scheduled_action(options = {}) ⇒ Struct

Deletes a scheduled action.

Examples:

Request syntax with placeholder values


resp = client.delete_scheduled_action({
  scheduled_action_name: "String", # required
})

Options Hash (options):

  • :scheduled_action_name (required, String)

    The name of the scheduled action to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_snapshot_copy_grant(options = {}) ⇒ Struct

Deletes the specified snapshot copy grant.

Examples:

Request syntax with placeholder values


resp = client.delete_snapshot_copy_grant({
  snapshot_copy_grant_name: "String", # required
})

Options Hash (options):

  • :snapshot_copy_grant_name (required, String)

    The name of the snapshot copy grant to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_snapshot_schedule(options = {}) ⇒ Struct

Deletes a snapshot schedule.

Examples:

Request syntax with placeholder values


resp = client.delete_snapshot_schedule({
  schedule_identifier: "String", # required
})

Options Hash (options):

  • :schedule_identifier (required, String)

    A unique identifier of the snapshot schedule to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_tags(options = {}) ⇒ Struct

Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

Examples:

Request syntax with placeholder values


resp = client.delete_tags({
  resource_name: "String", # required
  tag_keys: ["String"], # required
})

Options Hash (options):

  • :resource_name (required, String)

    The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

  • :tag_keys (required, Array<String>)

    The tag key that you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_usage_limit(options = {}) ⇒ Struct

Deletes a usage limit from a cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_usage_limit({
  usage_limit_id: "String", # required
})

Options Hash (options):

  • :usage_limit_id (required, String)

    The identifier of the usage limit to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_account_attributes(options = {}) ⇒ Types::AccountAttributeList

Returns a list of attributes attached to an account

Examples:

Request syntax with placeholder values


resp = client.({
  attribute_names: ["String"],
})

Response structure


resp. #=> Array
resp.[0].attribute_name #=> String
resp.[0].attribute_values #=> Array
resp.[0].attribute_values[0].attribute_value #=> String

Options Hash (options):

  • :attribute_names (Array<String>)

    A list of attribute names.

Returns:

See Also:

#describe_cluster_db_revisions(options = {}) ⇒ Types::ClusterDbRevisionsMessage

Returns an array of ClusterDbRevision objects.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_db_revisions({
  cluster_identifier: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.cluster_db_revisions #=> Array
resp.cluster_db_revisions[0].cluster_identifier #=> String
resp.cluster_db_revisions[0].current_database_revision #=> String
resp.cluster_db_revisions[0].database_revision_release_date #=> Time
resp.cluster_db_revisions[0].revision_targets #=> Array
resp.cluster_db_revisions[0].revision_targets[0].database_revision #=> String
resp.cluster_db_revisions[0].revision_targets[0].description #=> String
resp.cluster_db_revisions[0].revision_targets[0].database_revision_release_date #=> Time

Options Hash (options):

  • :cluster_identifier (String)

    A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.

Returns:

See Also:

#describe_cluster_parameter_groups(options = {}) ⇒ Types::ClusterParameterGroupsMessage

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_parameter_groups({
  parameter_group_name: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.parameter_groups #=> Array
resp.parameter_groups[0].parameter_group_name #=> String
resp.parameter_groups[0].parameter_group_family #=> String
resp.parameter_groups[0].description #=> String
resp.parameter_groups[0].tags #=> Array
resp.parameter_groups[0].tags[0].key #=> String
resp.parameter_groups[0].tags[0].value #=> String

Options Hash (options):

  • :parameter_group_name (String)

    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_cluster_parameters(options = {}) ⇒ Types::ClusterParameterGroupDetails

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_parameters({
  parameter_group_name: "String", # required
  source: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.parameters #=> Array
resp.parameters[0].parameter_name #=> String
resp.parameters[0].parameter_value #=> String
resp.parameters[0].description #=> String
resp.parameters[0].source #=> String
resp.parameters[0].data_type #=> String
resp.parameters[0].allowed_values #=> String
resp.parameters[0].apply_type #=> String, one of "static", "dynamic"
resp.parameters[0].is_modifiable #=> true/false
resp.parameters[0].minimum_engine_version #=> String
resp.marker #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of a cluster parameter group for which to return details.

  • :source (String)

    The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

    Default: All parameter types returned.

    Valid Values: user | engine-default

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_cluster_security_groups(options = {}) ⇒ Types::ClusterSecurityGroupMessage

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_security_groups({
  cluster_security_group_name: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.cluster_security_groups #=> Array
resp.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster_security_groups[0].description #=> String
resp.cluster_security_groups[0].ec2_security_groups #=> Array
resp.cluster_security_groups[0].ec2_security_groups[0].status #=> String
resp.cluster_security_groups[0].ec2_security_groups[0].ec2_security_group_name #=> String
resp.cluster_security_groups[0].ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cluster_security_groups[0].ec2_security_groups[0].tags #=> Array
resp.cluster_security_groups[0].ec2_security_groups[0].tags[0].key #=> String
resp.cluster_security_groups[0].ec2_security_groups[0].tags[0].value #=> String
resp.cluster_security_groups[0].ip_ranges #=> Array
resp.cluster_security_groups[0].ip_ranges[0].status #=> String
resp.cluster_security_groups[0].ip_ranges[0].cidrip #=> String
resp.cluster_security_groups[0].ip_ranges[0].tags #=> Array
resp.cluster_security_groups[0].ip_ranges[0].tags[0].key #=> String
resp.cluster_security_groups[0].ip_ranges[0].tags[0].value #=> String
resp.cluster_security_groups[0].tags #=> Array
resp.cluster_security_groups[0].tags[0].key #=> String
resp.cluster_security_groups[0].tags[0].value #=> String

Options Hash (options):

  • :cluster_security_group_name (String)

    The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

    Example: securitygroup1

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_cluster_snapshots(options = {}) ⇒ Types::SnapshotMessage

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_snapshots({
  cluster_identifier: "String",
  snapshot_identifier: "String",
  snapshot_type: "String",
  start_time: Time.now,
  end_time: Time.now,
  max_records: 1,
  marker: "String",
  owner_account: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
  cluster_exists: false,
  sorting_entities: [
    {
      attribute: "SOURCE_TYPE", # required, accepts SOURCE_TYPE, TOTAL_SIZE, CREATE_TIME
      sort_order: "ASC", # accepts ASC, DESC
    },
  ],
})

Response structure


resp.marker #=> String
resp.snapshots #=> Array
resp.snapshots[0].snapshot_identifier #=> String
resp.snapshots[0].cluster_identifier #=> String
resp.snapshots[0].snapshot_create_time #=> Time
resp.snapshots[0].status #=> String
resp.snapshots[0].port #=> Integer
resp.snapshots[0].availability_zone #=> String
resp.snapshots[0].cluster_create_time #=> Time
resp.snapshots[0].master_username #=> String
resp.snapshots[0].cluster_version #=> String
resp.snapshots[0].snapshot_type #=> String
resp.snapshots[0].node_type #=> String
resp.snapshots[0].number_of_nodes #=> Integer
resp.snapshots[0].db_name #=> String
resp.snapshots[0].vpc_id #=> String
resp.snapshots[0].encrypted #=> true/false
resp.snapshots[0].kms_key_id #=> String
resp.snapshots[0].encrypted_with_hsm #=> true/false
resp.snapshots[0].accounts_with_restore_access #=> Array
resp.snapshots[0].accounts_with_restore_access[0]. #=> String
resp.snapshots[0].accounts_with_restore_access[0]. #=> String
resp.snapshots[0]. #=> String
resp.snapshots[0].total_backup_size_in_mega_bytes #=> Float
resp.snapshots[0].actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshots[0].backup_progress_in_mega_bytes #=> Float
resp.snapshots[0].current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshots[0].estimated_seconds_to_completion #=> Integer
resp.snapshots[0].elapsed_time_in_seconds #=> Integer
resp.snapshots[0].source_region #=> String
resp.snapshots[0].tags #=> Array
resp.snapshots[0].tags[0].key #=> String
resp.snapshots[0].tags[0].value #=> String
resp.snapshots[0].restorable_node_types #=> Array
resp.snapshots[0].restorable_node_types[0] #=> String
resp.snapshots[0].enhanced_vpc_routing #=> true/false
resp.snapshots[0].maintenance_track_name #=> String
resp.snapshots[0].manual_snapshot_retention_period #=> Integer
resp.snapshots[0].manual_snapshot_remaining_days #=> Integer
resp.snapshots[0].snapshot_retention_start_time #=> Time

Options Hash (options):

  • :cluster_identifier (String)

    The identifier of the cluster which generated the requested snapshots.

  • :snapshot_identifier (String)

    The snapshot identifier of the snapshot about which to return information.

  • :snapshot_type (String)

    The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

    Valid Values: automated | manual

  • :start_time (Time)

    A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2012-07-16T18:00:00Z

  • :end_time (Time)

    A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2012-07-16T18:00:00Z

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :owner_account (String)

    The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

  • :cluster_exists (Boolean)

    A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

    • If ClusterExists is set to true, ClusterIdentifier is required.

    • If ClusterExists is set to false and ClusterIdentifier isn\'t specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

    • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

    • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

  • :sorting_entities (Array<Types::SnapshotSortingEntity>)

Returns:

See Also:

#describe_cluster_subnet_groups(options = {}) ⇒ Types::ClusterSubnetGroupMessage

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_subnet_groups({
  cluster_subnet_group_name: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.cluster_subnet_groups #=> Array
resp.cluster_subnet_groups[0].cluster_subnet_group_name #=> String
resp.cluster_subnet_groups[0].description #=> String
resp.cluster_subnet_groups[0].vpc_id #=> String
resp.cluster_subnet_groups[0].subnet_group_status #=> String
resp.cluster_subnet_groups[0].subnets #=> Array
resp.cluster_subnet_groups[0].subnets[0].subnet_identifier #=> String
resp.cluster_subnet_groups[0].subnets[0].subnet_availability_zone.name #=> String
resp.cluster_subnet_groups[0].subnets[0].subnet_availability_zone.supported_platforms #=> Array
resp.cluster_subnet_groups[0].subnets[0].subnet_availability_zone.supported_platforms[0].name #=> String
resp.cluster_subnet_groups[0].subnets[0].subnet_status #=> String
resp.cluster_subnet_groups[0].tags #=> Array
resp.cluster_subnet_groups[0].tags[0].key #=> String
resp.cluster_subnet_groups[0].tags[0].value #=> String

Options Hash (options):

  • :cluster_subnet_group_name (String)

    The name of the cluster subnet group for which information is requested.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_cluster_tracks(options = {}) ⇒ Types::TrackListMessage

Returns a list of all the available maintenance tracks.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_tracks({
  maintenance_track_name: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.maintenance_tracks #=> Array
resp.maintenance_tracks[0].maintenance_track_name #=> String
resp.maintenance_tracks[0].database_version #=> String
resp.maintenance_tracks[0].update_targets #=> Array
resp.maintenance_tracks[0].update_targets[0].maintenance_track_name #=> String
resp.maintenance_tracks[0].update_targets[0].database_version #=> String
resp.maintenance_tracks[0].update_targets[0].supported_operations #=> Array
resp.maintenance_tracks[0].update_targets[0].supported_operations[0].operation_name #=> String
resp.marker #=> String

Options Hash (options):

  • :maintenance_track_name (String)

    The name of the maintenance track.

  • :max_records (Integer)

    An integer value for the maximum number of maintenance tracks to return.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_cluster_versions(options = {}) ⇒ Types::ClusterVersionsMessage

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_versions({
  cluster_version: "String",
  cluster_parameter_group_family: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.cluster_versions #=> Array
resp.cluster_versions[0].cluster_version #=> String
resp.cluster_versions[0].cluster_parameter_group_family #=> String
resp.cluster_versions[0].description #=> String

Options Hash (options):

  • :cluster_version (String)

    The specific cluster version to return.

    Example: 1.0

  • :cluster_parameter_group_family (String)

    The name of a specific cluster parameter group family to return details for.

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_clusters(options = {}) ⇒ Types::ClustersMessage

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.

If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_clusters({
  cluster_identifier: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.clusters #=> Array
resp.clusters[0].cluster_identifier #=> String
resp.clusters[0].node_type #=> String
resp.clusters[0].cluster_status #=> String
resp.clusters[0].cluster_availability_status #=> String
resp.clusters[0].modify_status #=> String
resp.clusters[0].master_username #=> String
resp.clusters[0].db_name #=> String
resp.clusters[0].endpoint.address #=> String
resp.clusters[0].endpoint.port #=> Integer
resp.clusters[0].cluster_create_time #=> Time
resp.clusters[0].automated_snapshot_retention_period #=> Integer
resp.clusters[0].manual_snapshot_retention_period #=> Integer
resp.clusters[0].cluster_security_groups #=> Array
resp.clusters[0].cluster_security_groups[0].cluster_security_group_name #=> String
resp.clusters[0].cluster_security_groups[0].status #=> String
resp.clusters[0].vpc_security_groups #=> Array
resp.clusters[0].vpc_security_groups[0].vpc_security_group_id #=> String
resp.clusters[0].vpc_security_groups[0].status #=> String
resp.clusters[0].cluster_parameter_groups #=> Array
resp.clusters[0].cluster_parameter_groups[0].parameter_group_name #=> String
resp.clusters[0].cluster_parameter_groups[0].parameter_apply_status #=> String
resp.clusters[0].cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.clusters[0].cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.clusters[0].cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.clusters[0].cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.clusters[0].cluster_subnet_group_name #=> String
resp.clusters[0].vpc_id #=> String
resp.clusters[0].availability_zone #=> String
resp.clusters[0].preferred_maintenance_window #=> String
resp.clusters[0].pending_modified_values.master_user_password #=> String
resp.clusters[0].pending_modified_values.node_type #=> String
resp.clusters[0].pending_modified_values.number_of_nodes #=> Integer
resp.clusters[0].pending_modified_values.cluster_type #=> String
resp.clusters[0].pending_modified_values.cluster_version #=> String
resp.clusters[0].pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.clusters[0].pending_modified_values.cluster_identifier #=> String
resp.clusters[0].pending_modified_values.publicly_accessible #=> true/false
resp.clusters[0].pending_modified_values.enhanced_vpc_routing #=> true/false
resp.clusters[0].pending_modified_values.maintenance_track_name #=> String
resp.clusters[0].pending_modified_values.encryption_type #=> String
resp.clusters[0].cluster_version #=> String
resp.clusters[0].allow_version_upgrade #=> true/false
resp.clusters[0].number_of_nodes #=> Integer
resp.clusters[0].publicly_accessible #=> true/false
resp.clusters[0].encrypted #=> true/false
resp.clusters[0].restore_status.status #=> String
resp.clusters[0].restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.clusters[0].restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.clusters[0].restore_status.progress_in_mega_bytes #=> Integer
resp.clusters[0].restore_status.elapsed_time_in_seconds #=> Integer
resp.clusters[0].restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.clusters[0].data_transfer_progress.status #=> String
resp.clusters[0].data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.clusters[0].data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.clusters[0].data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.clusters[0].data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.clusters[0].data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.clusters[0].hsm_status.hsm_client_certificate_identifier #=> String
resp.clusters[0].hsm_status.hsm_configuration_identifier #=> String
resp.clusters[0].hsm_status.status #=> String
resp.clusters[0].cluster_snapshot_copy_status.destination_region #=> String
resp.clusters[0].cluster_snapshot_copy_status.retention_period #=> Integer
resp.clusters[0].cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.clusters[0].cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.clusters[0].cluster_public_key #=> String
resp.clusters[0].cluster_nodes #=> Array
resp.clusters[0].cluster_nodes[0].node_role #=> String
resp.clusters[0].cluster_nodes[0].private_ip_address #=> String
resp.clusters[0].cluster_nodes[0].public_ip_address #=> String
resp.clusters[0].elastic_ip_status.elastic_ip #=> String
resp.clusters[0].elastic_ip_status.status #=> String
resp.clusters[0].cluster_revision_number #=> String
resp.clusters[0].tags #=> Array
resp.clusters[0].tags[0].key #=> String
resp.clusters[0].tags[0].value #=> String
resp.clusters[0].kms_key_id #=> String
resp.clusters[0].enhanced_vpc_routing #=> true/false
resp.clusters[0].iam_roles #=> Array
resp.clusters[0].iam_roles[0].iam_role_arn #=> String
resp.clusters[0].iam_roles[0].apply_status #=> String
resp.clusters[0].pending_actions #=> Array
resp.clusters[0].pending_actions[0] #=> String
resp.clusters[0].maintenance_track_name #=> String
resp.clusters[0].elastic_resize_number_of_node_options #=> String
resp.clusters[0].deferred_maintenance_windows #=> Array
resp.clusters[0].deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.clusters[0].deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.clusters[0].deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.clusters[0].snapshot_schedule_identifier #=> String
resp.clusters[0].snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.clusters[0].expected_next_snapshot_schedule_time #=> Time
resp.clusters[0].expected_next_snapshot_schedule_time_status #=> String
resp.clusters[0].next_maintenance_window_start_time #=> Time
resp.clusters[0].resize_info.resize_type #=> String
resp.clusters[0].resize_info.allow_cancel_resize #=> true/false
resp.clusters[0].cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (String)

    The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

    The default is that all clusters defined for an account are returned.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_default_cluster_parameters(options = {}) ⇒ Types::DescribeDefaultClusterParametersResult

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_default_cluster_parameters({
  parameter_group_family: "String", # required
  max_records: 1,
  marker: "String",
})

Response structure


resp.default_cluster_parameters.parameter_group_family #=> String
resp.default_cluster_parameters.marker #=> String
resp.default_cluster_parameters.parameters #=> Array
resp.default_cluster_parameters.parameters[0].parameter_name #=> String
resp.default_cluster_parameters.parameters[0].parameter_value #=> String
resp.default_cluster_parameters.parameters[0].description #=> String
resp.default_cluster_parameters.parameters[0].source #=> String
resp.default_cluster_parameters.parameters[0].data_type #=> String
resp.default_cluster_parameters.parameters[0].allowed_values #=> String
resp.default_cluster_parameters.parameters[0].apply_type #=> String, one of "static", "dynamic"
resp.default_cluster_parameters.parameters[0].is_modifiable #=> true/false
resp.default_cluster_parameters.parameters[0].minimum_engine_version #=> String

Options Hash (options):

  • :parameter_group_family (required, String)

    The name of the cluster parameter group family.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_event_categories(options = {}) ⇒ Types::EventCategoriesMessage

Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

Examples:

Request syntax with placeholder values


resp = client.describe_event_categories({
  source_type: "String",
})

Response structure


resp.event_categories_map_list #=> Array
resp.event_categories_map_list[0].source_type #=> String
resp.event_categories_map_list[0].events #=> Array
resp.event_categories_map_list[0].events[0].event_id #=> String
resp.event_categories_map_list[0].events[0].event_categories #=> Array
resp.event_categories_map_list[0].events[0].event_categories[0] #=> String
resp.event_categories_map_list[0].events[0].event_description #=> String
resp.event_categories_map_list[0].events[0].severity #=> String

Options Hash (options):

  • :source_type (String)

    The source type, such as cluster or parameter group, to which the described event categories apply.

    Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.

Returns:

See Also:

#describe_event_subscriptions(options = {}) ⇒ Types::EventSubscriptionsMessage

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_event_subscriptions({
  subscription_name: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.event_subscriptions_list #=> Array
resp.event_subscriptions_list[0].customer_aws_id #=> String
resp.event_subscriptions_list[0].cust_subscription_id #=> String
resp.event_subscriptions_list[0].sns_topic_arn #=> String
resp.event_subscriptions_list[0].status #=> String
resp.event_subscriptions_list[0].subscription_creation_time #=> Time
resp.event_subscriptions_list[0].source_type #=> String
resp.event_subscriptions_list[0].source_ids_list #=> Array
resp.event_subscriptions_list[0].source_ids_list[0] #=> String
resp.event_subscriptions_list[0].event_categories_list #=> Array
resp.event_subscriptions_list[0].event_categories_list[0] #=> String
resp.event_subscriptions_list[0].severity #=> String
resp.event_subscriptions_list[0].enabled #=> true/false
resp.event_subscriptions_list[0].tags #=> Array
resp.event_subscriptions_list[0].tags[0].key #=> String
resp.event_subscriptions_list[0].tags[0].value #=> String

Options Hash (options):

  • :subscription_name (String)

    The name of the Amazon Redshift event notification subscription to be described.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_events(options = {}) ⇒ Types::EventsMessage

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Examples:

Request syntax with placeholder values


resp = client.describe_events({
  source_identifier: "String",
  source_type: "cluster", # accepts cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, scheduled-action
  start_time: Time.now,
  end_time: Time.now,
  duration: 1,
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.events #=> Array
resp.events[0].source_identifier #=> String
resp.events[0].source_type #=> String, one of "cluster", "cluster-parameter-group", "cluster-security-group", "cluster-snapshot", "scheduled-action"
resp.events[0].message #=> String
resp.events[0].event_categories #=> Array
resp.events[0].event_categories[0] #=> String
resp.events[0].severity #=> String
resp.events[0].date #=> Time
resp.events[0].event_id #=> String

Options Hash (options):

  • :source_identifier (String)

    The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

    Constraints:

    If SourceIdentifier is supplied, SourceType must also be provided.

    • Specify a cluster identifier when SourceType is cluster.

    • Specify a cluster security group name when SourceType is cluster-security-group.

    • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

    • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

  • :source_type (String)

    The event source to retrieve events for. If no value is specified, all events are returned.

    Constraints:

    If SourceType is supplied, SourceIdentifier must also be provided.

    • Specify cluster when SourceIdentifier is a cluster identifier.

    • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

    • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

    • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

  • :start_time (Time)

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :end_time (Time)

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

  • :duration (Integer)

    The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

    Default: 60

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_hsm_client_certificates(options = {}) ⇒ Types::HsmClientCertificateMessage

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_hsm_client_certificates({
  hsm_client_certificate_identifier: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.hsm_client_certificates #=> Array
resp.hsm_client_certificates[0].hsm_client_certificate_identifier #=> String
resp.hsm_client_certificates[0].hsm_client_certificate_public_key #=> String
resp.hsm_client_certificates[0].tags #=> Array
resp.hsm_client_certificates[0].tags[0].key #=> String
resp.hsm_client_certificates[0].tags[0].value #=> String

Options Hash (options):

  • :hsm_client_certificate_identifier (String)

    The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_hsm_configurations(options = {}) ⇒ Types::HsmConfigurationMessage

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_hsm_configurations({
  hsm_configuration_identifier: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.hsm_configurations #=> Array
resp.hsm_configurations[0].hsm_configuration_identifier #=> String
resp.hsm_configurations[0].description #=> String
resp.hsm_configurations[0].hsm_ip_address #=> String
resp.hsm_configurations[0].hsm_partition_name #=> String
resp.hsm_configurations[0].tags #=> Array
resp.hsm_configurations[0].tags[0].key #=> String
resp.hsm_configurations[0].tags[0].value #=> String

Options Hash (options):

  • :hsm_configuration_identifier (String)

    The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_logging_status(options = {}) ⇒ Types::LoggingStatus

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Examples:

Request syntax with placeholder values


resp = client.describe_logging_status({
  cluster_identifier: "String", # required
})

Response structure


resp.logging_enabled #=> true/false
resp.bucket_name #=> String
resp.s3_key_prefix #=> String
resp.last_successful_delivery_time #=> Time
resp.last_failure_time #=> Time
resp.last_failure_message #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster from which to get the logging status.

    Example: examplecluster

Returns:

See Also:

#describe_node_configuration_options(options = {}) ⇒ Types::NodeConfigurationOptionsMessage

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Examples:

Request syntax with placeholder values


resp = client.describe_node_configuration_options({
  action_type: "restore-cluster", # required, accepts restore-cluster, recommend-node-config, resize-cluster
  cluster_identifier: "String",
  snapshot_identifier: "String",
  owner_account: "String",
  filters: [
    {
      name: "NodeType", # accepts NodeType, NumberOfNodes, EstimatedDiskUtilizationPercent, Mode
      operator: "eq", # accepts eq, lt, gt, le, ge, in, between
      values: ["String"],
    },
  ],
  marker: "String",
  max_records: 1,
})

Response structure


resp.node_configuration_option_list #=> Array
resp.node_configuration_option_list[0].node_type #=> String
resp.node_configuration_option_list[0].number_of_nodes #=> Integer
resp.node_configuration_option_list[0].estimated_disk_utilization_percent #=> Float
resp.node_configuration_option_list[0].mode #=> String, one of "standard", "high-performance"
resp.marker #=> String

Options Hash (options):

  • :action_type (required, String)

    The action type to evaluate for possible node configurations. Specify \"restore-cluster\" to get configuration combinations based on an existing snapshot. Specify \"recommend-node-config\" to get configuration recommendations based on an existing cluster or snapshot. Specify \"resize-cluster\" to get configuration combinations for elastic resize based on an existing cluster.

  • :cluster_identifier (String)

    The identifier of the cluster to evaluate for possible node configurations.

  • :snapshot_identifier (String)

    The identifier of the snapshot to evaluate for possible node configurations.

  • :owner_account (String)

    The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

  • :filters (Array<Types::NodeConfigurationOptionsFilter>)

    A set of name, operator, and value items to filter the results.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 500

    Constraints: minimum 100, maximum 500.

Returns:

See Also:

#describe_orderable_cluster_options(options = {}) ⇒ Types::OrderableClusterOptionsMessage

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_orderable_cluster_options({
  cluster_version: "String",
  node_type: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.orderable_cluster_options #=> Array
resp.orderable_cluster_options[0].cluster_version #=> String
resp.orderable_cluster_options[0].cluster_type #=> String
resp.orderable_cluster_options[0].node_type #=> String
resp.orderable_cluster_options[0].availability_zones #=> Array
resp.orderable_cluster_options[0].availability_zones[0].name #=> String
resp.orderable_cluster_options[0].availability_zones[0].supported_platforms #=> Array
resp.orderable_cluster_options[0].availability_zones[0].supported_platforms[0].name #=> String
resp.marker #=> String

Options Hash (options):

  • :cluster_version (String)

    The version filter value. Specify this parameter to show only the available offerings matching the specified version.

    Default: All versions.

    Constraints: Must be one of the version returned from DescribeClusterVersions.

  • :node_type (String)

    The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_reserved_node_offerings(options = {}) ⇒ Types::ReservedNodeOfferingsMessage

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_node_offerings({
  reserved_node_offering_id: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.reserved_node_offerings #=> Array
resp.reserved_node_offerings[0].reserved_node_offering_id #=> String
resp.reserved_node_offerings[0].node_type #=> String
resp.reserved_node_offerings[0].duration #=> Integer
resp.reserved_node_offerings[0].fixed_price #=> Float
resp.reserved_node_offerings[0].usage_price #=> Float
resp.reserved_node_offerings[0].currency_code #=> String
resp.reserved_node_offerings[0].offering_type #=> String
resp.reserved_node_offerings[0].recurring_charges #=> Array
resp.reserved_node_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_node_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_node_offerings[0].reserved_node_offering_type #=> String, one of "Regular", "Upgradable"

Options Hash (options):

  • :reserved_node_offering_id (String)

    The unique identifier for the offering.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_reserved_nodes(options = {}) ⇒ Types::ReservedNodesMessage

Returns the descriptions of the reserved nodes.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_nodes({
  reserved_node_id: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.reserved_nodes #=> Array
resp.reserved_nodes[0].reserved_node_id #=> String
resp.reserved_nodes[0].reserved_node_offering_id #=> String
resp.reserved_nodes[0].node_type #=> String
resp.reserved_nodes[0].start_time #=> Time
resp.reserved_nodes[0].duration #=> Integer
resp.reserved_nodes[0].fixed_price #=> Float
resp.reserved_nodes[0].usage_price #=> Float
resp.reserved_nodes[0].currency_code #=> String
resp.reserved_nodes[0].node_count #=> Integer
resp.reserved_nodes[0].state #=> String
resp.reserved_nodes[0].offering_type #=> String
resp.reserved_nodes[0].recurring_charges #=> Array
resp.reserved_nodes[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_nodes[0].recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_nodes[0].reserved_node_offering_type #=> String, one of "Regular", "Upgradable"

Options Hash (options):

  • :reserved_node_id (String)

    Identifier for the node reservation.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

See Also:

#describe_resize(options = {}) ⇒ Types::ResizeProgressMessage

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

Examples:

Request syntax with placeholder values


resp = client.describe_resize({
  cluster_identifier: "String", # required
})

Response structure


resp.target_node_type #=> String
resp.target_number_of_nodes #=> Integer
resp.target_cluster_type #=> String
resp.status #=> String
resp.import_tables_completed #=> Array
resp.import_tables_completed[0] #=> String
resp.import_tables_in_progress #=> Array
resp.import_tables_in_progress[0] #=> String
resp.import_tables_not_started #=> Array
resp.import_tables_not_started[0] #=> String
resp.avg_resize_rate_in_mega_bytes_per_second #=> Float
resp.total_resize_data_in_mega_bytes #=> Integer
resp.progress_in_mega_bytes #=> Integer
resp.elapsed_time_in_seconds #=> Integer
resp.estimated_time_to_completion_in_seconds #=> Integer
resp.resize_type #=> String
resp.message #=> String
resp.target_encryption_type #=> String
resp.data_transfer_progress_percent #=> Float

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

    By default, resize operations for all clusters defined for an AWS account are returned.

Returns:

See Also:

#describe_scheduled_actions(options = {}) ⇒ Types::ScheduledActionsMessage

Describes properties of scheduled actions.

Examples:

Request syntax with placeholder values


resp = client.describe_scheduled_actions({
  scheduled_action_name: "String",
  target_action_type: "ResizeCluster", # accepts ResizeCluster, PauseCluster, ResumeCluster
  start_time: Time.now,
  end_time: Time.now,
  active: false,
  filters: [
    {
      name: "cluster-identifier", # required, accepts cluster-identifier, iam-role
      values: ["String"], # required
    },
  ],
  marker: "String",
  max_records: 1,
})

Response structure


resp.marker #=> String
resp.scheduled_actions #=> Array
resp.scheduled_actions[0].scheduled_action_name #=> String
resp.scheduled_actions[0].target_action.resize_cluster.cluster_identifier #=> String
resp.scheduled_actions[0].target_action.resize_cluster.cluster_type #=> String
resp.scheduled_actions[0].target_action.resize_cluster.node_type #=> String
resp.scheduled_actions[0].target_action.resize_cluster.number_of_nodes #=> Integer
resp.scheduled_actions[0].target_action.resize_cluster.classic #=> true/false
resp.scheduled_actions[0].target_action.pause_cluster.cluster_identifier #=> String
resp.scheduled_actions[0].target_action.resume_cluster.cluster_identifier #=> String
resp.scheduled_actions[0].schedule #=> String
resp.scheduled_actions[0].iam_role #=> String
resp.scheduled_actions[0].scheduled_action_description #=> String
resp.scheduled_actions[0].state #=> String, one of "ACTIVE", "DISABLED"
resp.scheduled_actions[0].next_invocations #=> Array
resp.scheduled_actions[0].next_invocations[0] #=> Time
resp.scheduled_actions[0].start_time #=> Time
resp.scheduled_actions[0].end_time #=> Time

Options Hash (options):

  • :scheduled_action_name (String)

    The name of the scheduled action to retrieve.

  • :target_action_type (String)

    The type of the scheduled actions to retrieve.

  • :start_time (Time)

    The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

  • :end_time (Time)

    The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

  • :active (Boolean)

    If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

  • :filters (Array<Types::ScheduledActionFilter>)

    List of scheduled action filters.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

Returns:

See Also:

#describe_snapshot_copy_grants(options = {}) ⇒ Types::SnapshotCopyGrantMessage

Returns a list of snapshot copy grants owned by the AWS account in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_snapshot_copy_grants({
  snapshot_copy_grant_name: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.snapshot_copy_grants #=> Array
resp.snapshot_copy_grants[0].snapshot_copy_grant_name #=> String
resp.snapshot_copy_grants[0].kms_key_id #=> String
resp.snapshot_copy_grants[0].tags #=> Array
resp.snapshot_copy_grants[0].tags[0].key #=> String
resp.snapshot_copy_grants[0].tags[0].value #=> String

Options Hash (options):

  • :snapshot_copy_grant_name (String)

    The name of the snapshot copy grant.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_snapshot_schedules(options = {}) ⇒ Types::DescribeSnapshotSchedulesOutputMessage

Returns a list of snapshot schedules.

Examples:

Request syntax with placeholder values


resp = client.describe_snapshot_schedules({
  cluster_identifier: "String",
  schedule_identifier: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
  marker: "String",
  max_records: 1,
})

Response structure


resp.snapshot_schedules #=> Array
resp.snapshot_schedules[0].schedule_definitions #=> Array
resp.snapshot_schedules[0].schedule_definitions[0] #=> String
resp.snapshot_schedules[0].schedule_identifier #=> String
resp.snapshot_schedules[0].schedule_description #=> String
resp.snapshot_schedules[0].tags #=> Array
resp.snapshot_schedules[0].tags[0].key #=> String
resp.snapshot_schedules[0].tags[0].value #=> String
resp.snapshot_schedules[0].next_invocations #=> Array
resp.snapshot_schedules[0].next_invocations[0] #=> Time
resp.snapshot_schedules[0].associated_cluster_count #=> Integer
resp.snapshot_schedules[0].associated_clusters #=> Array
resp.snapshot_schedules[0].associated_clusters[0].cluster_identifier #=> String
resp.snapshot_schedules[0].associated_clusters[0].schedule_association_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.marker #=> String

Options Hash (options):

  • :cluster_identifier (String)

    The unique identifier for the cluster whose snapshot schedules you want to view.

  • :schedule_identifier (String)

    A unique identifier for a snapshot schedule.

  • :tag_keys (Array<String>)

    The key value for a snapshot schedule tag.

  • :tag_values (Array<String>)

    The value corresponding to the key of the snapshot schedule tag.

  • :marker (String)

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

  • :max_records (Integer)

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Returns:

See Also:

#describe_storage(options = {}) ⇒ Types::CustomerStorageMessage

Returns account level backups storage size and provisional storage.

Examples:

Request syntax with placeholder values


resp = client.describe_storage()

Response structure


resp.total_backup_size_in_mega_bytes #=> Float
resp.total_provisioned_storage_in_mega_bytes #=> Float

Returns:

See Also:

#describe_table_restore_status(options = {}) ⇒ Types::TableRestoreStatusMessage

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

Examples:

Request syntax with placeholder values


resp = client.describe_table_restore_status({
  cluster_identifier: "String",
  table_restore_request_id: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.table_restore_status_details #=> Array
resp.table_restore_status_details[0].table_restore_request_id #=> String
resp.table_restore_status_details[0].status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"
resp.table_restore_status_details[0].message #=> String
resp.table_restore_status_details[0].request_time #=> Time
resp.table_restore_status_details[0].progress_in_mega_bytes #=> Integer
resp.table_restore_status_details[0].total_data_in_mega_bytes #=> Integer
resp.table_restore_status_details[0].cluster_identifier #=> String
resp.table_restore_status_details[0].snapshot_identifier #=> String
resp.table_restore_status_details[0].source_database_name #=> String
resp.table_restore_status_details[0].source_schema_name #=> String
resp.table_restore_status_details[0].source_table_name #=> String
resp.table_restore_status_details[0].target_database_name #=> String
resp.table_restore_status_details[0].target_schema_name #=> String
resp.table_restore_status_details[0].new_table_name #=> String
resp.marker #=> String

Options Hash (options):

  • :cluster_identifier (String)

    The Amazon Redshift cluster that the table is being restored to.

  • :table_restore_request_id (String)

    The identifier of the table restore request to return status for. If you don\'t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

  • :max_records (Integer)

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

  • :marker (String)

    An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Returns:

See Also:

#describe_tags(options = {}) ⇒ Types::TaggedResourceListMessage

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags:

  • You cannot specify an ARN and a resource-type value together in the same request.

  • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.

  • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Examples:

Request syntax with placeholder values


resp = client.describe_tags({
  resource_name: "String",
  resource_type: "String",
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.tagged_resources #=> Array
resp.tagged_resources[0].tag.key #=> String
resp.tagged_resources[0].tag.value #=> String
resp.tagged_resources[0].resource_name #=> String
resp.tagged_resources[0].resource_type #=> String
resp.marker #=> String

Options Hash (options):

  • :resource_name (String)

    The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

  • :resource_type (String)

    The type of resource with which you want to view tags. Valid resource types are:

    • Cluster

    • CIDR/IP

    • EC2 security group

    • Snapshot

    • Cluster security group

    • Subnet group

    • HSM connection

    • HSM certificate

    • Parameter group

    • Snapshot copy grant

    For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

  • :max_records (Integer)

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

  • :marker (String)

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Returns:

See Also:

#describe_usage_limits(options = {}) ⇒ Types::UsageLimitList

Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

  • If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.

  • If usage limit identifier is provided, then the corresponding usage limit object is returned.

  • If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.

  • If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.

Examples:

Request syntax with placeholder values


resp = client.describe_usage_limits({
  usage_limit_id: "String",
  cluster_identifier: "String",
  feature_type: "spectrum", # accepts spectrum, concurrency-scaling
  max_records: 1,
  marker: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.usage_limits #=> Array
resp.usage_limits[0].usage_limit_id #=> String
resp.usage_limits[0].cluster_identifier #=> String
resp.usage_limits[0].feature_type #=> String, one of "spectrum", "concurrency-scaling"
resp.usage_limits[0].limit_type #=> String, one of "time", "data-scanned"
resp.usage_limits[0].amount #=> Integer
resp.usage_limits[0].period #=> String, one of "daily", "weekly", "monthly"
resp.usage_limits[0].breach_action #=> String, one of "log", "emit-metric", "disable"
resp.usage_limits[0].tags #=> Array
resp.usage_limits[0].tags[0].key #=> String
resp.usage_limits[0].tags[0].value #=> String
resp.marker #=> String

Options Hash (options):

  • :usage_limit_id (String)

    The identifier of the usage limit to describe.

  • :cluster_identifier (String)

    The identifier of the cluster for which you want to describe usage limits.

  • :feature_type (String)

    The feature type for which you want to describe usage limits.

  • :max_records (Integer)

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

  • :marker (String)

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeUsageLimits request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

  • :tag_keys (Array<String>)

    A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

  • :tag_values (Array<String>)

    A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

Returns:

See Also:

#disable_logging(options = {}) ⇒ Types::LoggingStatus

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Examples:

Request syntax with placeholder values


resp = client.disable_logging({
  cluster_identifier: "String", # required
})

Response structure


resp.logging_enabled #=> true/false
resp.bucket_name #=> String
resp.s3_key_prefix #=> String
resp.last_successful_delivery_time #=> Time
resp.last_failure_time #=> Time
resp.last_failure_message #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster on which logging is to be stopped.

    Example: examplecluster

Returns:

See Also:

#disable_snapshot_copy(options = {}) ⇒ Types::DisableSnapshotCopyResult

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.

Examples:

Request syntax with placeholder values


resp = client.disable_snapshot_copy({
  cluster_identifier: "String", # required
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.

    Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Returns:

See Also:

#enable_logging(options = {}) ⇒ Types::LoggingStatus

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Examples:

Request syntax with placeholder values


resp = client.enable_logging({
  cluster_identifier: "String", # required
  bucket_name: "String", # required
  s3_key_prefix: "String",
})

Response structure


resp.logging_enabled #=> true/false
resp.bucket_name #=> String
resp.s3_key_prefix #=> String
resp.last_successful_delivery_time #=> Time
resp.last_failure_time #=> Time
resp.last_failure_message #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster on which logging is to be started.

    Example: examplecluster

  • :bucket_name (required, String)

    The name of an existing S3 bucket where the log files are to be stored.

    Constraints:

    • Must be in the same region as the cluster

    • The cluster must have read bucket and put object permissions

  • :s3_key_prefix (String)

    The prefix applied to the log file names.

    Constraints:

    • Cannot exceed 512 characters

    • Cannot contain spaces( ), double quotes (\"), single quotes (\'), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:

      • x00 to x20

      • x22

      • x27

      • x5c

      • x7f or larger

Returns:

See Also:

#enable_snapshot_copy(options = {}) ⇒ Types::EnableSnapshotCopyResult

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Examples:

Request syntax with placeholder values


resp = client.enable_snapshot_copy({
  cluster_identifier: "String", # required
  destination_region: "String", # required
  retention_period: 1,
  snapshot_copy_grant_name: "String",
  manual_snapshot_retention_period: 1,
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of the source cluster to copy snapshots from.

    Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

  • :destination_region (required, 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 General Reference.

  • :retention_period (Integer)

    The number of days to retain automated snapshots in the destination region after they are copied from the source region.

    Default: 7.

    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.

    The value must be either -1 or an integer between 1 and 3,653.

Returns:

See Also:

#get_cluster_credentials(options = {}) ⇒ Types::ClusterCredentials

Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.

If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.

In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Examples:

Request syntax with placeholder values


resp = client.get_cluster_credentials({
  db_user: "String", # required
  db_name: "String",
  cluster_identifier: "String", # required
  duration_seconds: 1,
  auto_create: false,
  db_groups: ["String"],
})

Response structure


resp.db_user #=> String
resp.db_password #=> String
resp.expiration #=> Time

Options Hash (options):

  • :db_user (required, String)

    The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn\'t exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn\'t exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn\'t exist in the database.

    For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens. The user name can\'t be PUBLIC.

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

  • :db_name (String)

    The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

  • :cluster_identifier (required, String)

    The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

  • :duration_seconds (Integer)

    The number of seconds until the returned temporary password expires.

    Constraint: minimum 900, maximum 3600.

    Default: 900

  • :auto_create (Boolean)

    Create a database user with the name specified for the user named in DbUser if one does not exist.

  • :db_groups (Array<String>)

    A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

    Database group name constraints

    • Must be 1 to 64 alphanumeric characters or hyphens

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Returns:

See Also:

#get_reserved_node_exchange_offerings(options = {}) ⇒ Types::GetReservedNodeExchangeOfferingsOutputMessage

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

Examples:

Request syntax with placeholder values


resp = client.get_reserved_node_exchange_offerings({
  reserved_node_id: "String", # required
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.reserved_node_offerings #=> Array
resp.reserved_node_offerings[0].reserved_node_offering_id #=> String
resp.reserved_node_offerings[0].node_type #=> String
resp.reserved_node_offerings[0].duration #=> Integer
resp.reserved_node_offerings[0].fixed_price #=> Float
resp.reserved_node_offerings[0].usage_price #=> Float
resp.reserved_node_offerings[0].currency_code #=> String
resp.reserved_node_offerings[0].offering_type #=> String
resp.reserved_node_offerings[0].recurring_charges #=> Array
resp.reserved_node_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_node_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_node_offerings[0].reserved_node_offering_type #=> String, one of "Regular", "Upgradable"

Options Hash (options):

  • :reserved_node_id (required, String)

    A string representing the node identifier for the DC1 Reserved Node to be exchanged.

  • :max_records (Integer)

    An integer setting the maximum number of ReservedNodeOfferings to retrieve.

  • :marker (String)

    A value that indicates the starting point for the next set of ReservedNodeOfferings.

Returns:

See Also:

#modify_cluster(options = {}) ⇒ Types::ModifyClusterResult

Modifies the settings for a cluster.

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster({
  cluster_identifier: "String", # required
  cluster_type: "String",
  node_type: "String",
  number_of_nodes: 1,
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  master_user_password: "String",
  cluster_parameter_group_name: "String",
  automated_snapshot_retention_period: 1,
  manual_snapshot_retention_period: 1,
  preferred_maintenance_window: "String",
  cluster_version: "String",
  allow_version_upgrade: false,
  hsm_client_certificate_identifier: "String",
  hsm_configuration_identifier: "String",
  new_cluster_identifier: "String",
  publicly_accessible: false,
  elastic_ip: "String",
  enhanced_vpc_routing: false,
  maintenance_track_name: "String",
  encrypted: false,
  kms_key_id: "String",
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of the cluster to be modified.

    Example: examplecluster

  • :cluster_type (String)

    The new cluster type.

    When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

    Valid Values: multi-node | single-node

  • :node_type (String)

    The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

    For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge

  • :number_of_nodes (Integer)

    The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

    For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    Valid Values: Integer greater than 0.

  • :cluster_security_groups (Array<String>)

    A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

    Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

  • :vpc_security_group_ids (Array<String>)

    A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

  • :master_user_password (String)

    The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

    Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

    Default: Uses existing setting.

    Constraints:

    • Must be between 8 and 64 characters in length.

    • Must contain at least one uppercase letter.

    • Must contain at least one lowercase letter.

    • Must contain one number.

    • Can be any printable ASCII character (ASCII code 33 to 126) except \' (single quote), \" (double quote), \, /, @, or space.

  • :cluster_parameter_group_name (String)

    The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

    Default: Uses existing setting.

    Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

  • :automated_snapshot_retention_period (Integer)

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

    Default: Uses existing setting.

    Constraints: Must be a value from 0 to 35.

  • :manual_snapshot_retention_period (Integer)

    The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn\'t retroactively change the retention periods of existing manual snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

  • :preferred_maintenance_window (String)

    The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

    This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

    Default: Uses existing setting.

    Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes.

  • :cluster_version (String)

    The new version number of the Amazon Redshift engine to upgrade to.

    For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    Example: 1.0

  • :allow_version_upgrade (Boolean)

    If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

    Default: false

  • :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.

  • :new_cluster_identifier (String)

    The new identifier for the cluster.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

    Example: examplecluster

  • :publicly_accessible (Boolean)

    If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

  • :elastic_ip (String)

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

  • :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.

    If this option is true, enhanced VPC routing is enabled.

    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.

  • :encrypted (Boolean)

    Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don\'t provide a KmsKeyId, we encrypt with the default key.

    If the value is not encrypted (false), then the cluster is decrypted.

  • :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.

Returns:

See Also:

#modify_cluster_db_revision(options = {}) ⇒ Types::ModifyClusterDbRevisionResult

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_db_revision({
  cluster_identifier: "String", # required
  revision_target: "String", # required
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of a cluster whose database revision you want to modify.

    Example: examplecluster

  • :revision_target (required, String)

    The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

Returns:

See Also:

#modify_cluster_iam_roles(options = {}) ⇒ Types::ModifyClusterIamRolesResult

Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

A cluster can have up to 10 IAM roles associated at any time.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_iam_roles({
  cluster_identifier: "String", # required
  add_iam_roles: ["String"],
  remove_iam_roles: ["String"],
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

  • :add_iam_roles (Array<String>)

    Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.

  • :remove_iam_roles (Array<String>)

    Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

Returns:

See Also:

#modify_cluster_maintenance(options = {}) ⇒ Types::ModifyClusterMaintenanceResult

Modifies the maintenance settings of a cluster.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_maintenance({
  cluster_identifier: "String", # required
  defer_maintenance: false,
  defer_maintenance_identifier: "String",
  defer_maintenance_start_time: Time.now,
  defer_maintenance_end_time: Time.now,
  defer_maintenance_duration: 1,
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    A unique identifier for the cluster.

  • :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 (Time)

    A timestamp indicating the start time for the deferred maintenance window.

  • :defer_maintenance_end_time (Time)

    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.

Returns:

See Also:

#modify_cluster_parameter_group(options = {}) ⇒ Types::ClusterParameterGroupNameMessage

Modifies the parameters of a parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_parameter_group({
  parameter_group_name: "String", # required
  parameters: [ # required
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      data_type: "String",
      allowed_values: "String",
      apply_type: "static", # accepts static, dynamic
      is_modifiable: false,
      minimum_engine_version: "String",
    },
  ],
})

Response structure


resp.parameter_group_name #=> String
resp.parameter_group_status #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the parameter group to be modified.

  • :parameters (required, Array<Types::Parameter>)

    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

    For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

    For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Returns:

See Also:

#modify_cluster_snapshot(options = {}) ⇒ Types::ModifyClusterSnapshotResult

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_snapshot({
  snapshot_identifier: "String", # required
  manual_snapshot_retention_period: 1,
  force: false,
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> true/false
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> true/false
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot. #=> String
resp.snapshot.total_backup_size_in_mega_bytes #=> Float
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.source_region #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.restorable_node_types #=> Array
resp.snapshot.restorable_node_types[0] #=> String
resp.snapshot.enhanced_vpc_routing #=> true/false
resp.snapshot.maintenance_track_name #=> String
resp.snapshot.manual_snapshot_retention_period #=> Integer
resp.snapshot.manual_snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time

Options Hash (options):

  • :snapshot_identifier (required, String)

    The identifier of the snapshot whose setting you want to modify.

  • :manual_snapshot_retention_period (Integer)

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

    The value must be either -1 or an integer between 1 and 3,653.

  • :force (Boolean)

    A Boolean option to override an exception if the retention period has already passed.

Returns:

See Also:

#modify_cluster_snapshot_schedule(options = {}) ⇒ Struct

Modifies a snapshot schedule for a cluster.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_snapshot_schedule({
  cluster_identifier: "String", # required
  schedule_identifier: "String",
  disassociate_schedule: false,
})

Options Hash (options):

  • :cluster_identifier (required, String)

    A unique identifier for the cluster whose snapshot schedule you want to modify.

  • :schedule_identifier (String)

    A unique alphanumeric identifier for the schedule that you want to associate with the cluster.

  • :disassociate_schedule (Boolean)

    A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#modify_cluster_subnet_group(options = {}) ⇒ Types::ModifyClusterSubnetGroupResult

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_subnet_group({
  cluster_subnet_group_name: "String", # required
  description: "String",
  subnet_ids: ["String"], # required
})

Response structure


resp.cluster_subnet_group.cluster_subnet_group_name #=> String
resp.cluster_subnet_group.description #=> String
resp.cluster_subnet_group.vpc_id #=> String
resp.cluster_subnet_group.subnet_group_status #=> String
resp.cluster_subnet_group.subnets #=> Array
resp.cluster_subnet_group.subnets[0].subnet_identifier #=> String
resp.cluster_subnet_group.subnets[0].subnet_availability_zone.name #=> String
resp.cluster_subnet_group.subnets[0].subnet_availability_zone.supported_platforms #=> Array
resp.cluster_subnet_group.subnets[0].subnet_availability_zone.supported_platforms[0].name #=> String
resp.cluster_subnet_group.subnets[0].subnet_status #=> String
resp.cluster_subnet_group.tags #=> Array
resp.cluster_subnet_group.tags[0].key #=> String
resp.cluster_subnet_group.tags[0].value #=> String

Options Hash (options):

  • :cluster_subnet_group_name (required, String)

    The name of the subnet group to be modified.

  • :description (String)

    A text description of the subnet group to be modified.

  • :subnet_ids (required, Array<String>)

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Returns:

See Also:

#modify_event_subscription(options = {}) ⇒ Types::ModifyEventSubscriptionResult

Modifies an existing Amazon Redshift event notification subscription.

Examples:

Request syntax with placeholder values


resp = client.modify_event_subscription({
  subscription_name: "String", # required
  sns_topic_arn: "String",
  source_type: "String",
  source_ids: ["String"],
  event_categories: ["String"],
  severity: "String",
  enabled: false,
})

Response structure


resp.event_subscription.customer_aws_id #=> String
resp.event_subscription.cust_subscription_id #=> String
resp.event_subscription.sns_topic_arn #=> String
resp.event_subscription.status #=> String
resp.event_subscription.subscription_creation_time #=> Time
resp.event_subscription.source_type #=> String
resp.event_subscription.source_ids_list #=> Array
resp.event_subscription.source_ids_list[0] #=> String
resp.event_subscription.event_categories_list #=> Array
resp.event_subscription.event_categories_list[0] #=> String
resp.event_subscription.severity #=> String
resp.event_subscription.enabled #=> true/false
resp.event_subscription.tags #=> Array
resp.event_subscription.tags[0].key #=> String
resp.event_subscription.tags[0].value #=> String

Options Hash (options):

  • :subscription_name (required, String)

    The name of the modified Amazon Redshift event notification subscription.

  • :sns_topic_arn (String)

    The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

  • :source_type (String)

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

  • :source_ids (Array<String>)

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

    Example: my-cluster-1, my-cluster-2

    Example: my-snapshot-20131010

  • :event_categories (Array<String>)

    Specifies the Amazon Redshift event categories to be published by the event notification subscription.

    Values: configuration, management, monitoring, security

  • :severity (String)

    Specifies the Amazon Redshift event severity to be published by the event notification subscription.

    Values: ERROR, INFO

  • :enabled (Boolean)

    A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

Returns:

See Also:

#modify_scheduled_action(options = {}) ⇒ Types::ScheduledAction

Modifies a scheduled action.

Examples:

Request syntax with placeholder values


resp = client.modify_scheduled_action({
  scheduled_action_name: "String", # required
  target_action: {
    resize_cluster: {
      cluster_identifier: "String", # required
      cluster_type: "String",
      node_type: "String",
      number_of_nodes: 1,
      classic: false,
    },
    pause_cluster: {
      cluster_identifier: "String", # required
    },
    resume_cluster: {
      cluster_identifier: "String", # required
    },
  },
  schedule: "String",
  iam_role: "String",
  scheduled_action_description: "String",
  start_time: Time.now,
  end_time: Time.now,
  enable: false,
})

Response structure


resp.scheduled_action_name #=> String
resp.target_action.resize_cluster.cluster_identifier #=> String
resp.target_action.resize_cluster.cluster_type #=> String
resp.target_action.resize_cluster.node_type #=> String
resp.target_action.resize_cluster.number_of_nodes #=> Integer
resp.target_action.resize_cluster.classic #=> true/false
resp.target_action.pause_cluster.cluster_identifier #=> String
resp.target_action.resume_cluster.cluster_identifier #=> String
resp.schedule #=> String
resp.iam_role #=> String
resp.scheduled_action_description #=> String
resp.state #=> String, one of "ACTIVE", "DISABLED"
resp.next_invocations #=> Array
resp.next_invocations[0] #=> Time
resp.start_time #=> Time
resp.end_time #=> Time

Options Hash (options):

  • :scheduled_action_name (required, String)

    The name of the scheduled action to modify.

  • :target_action (Types::ScheduledActionType)

    A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

  • :schedule (String)

    A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

  • :iam_role (String)

    A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

  • :scheduled_action_description (String)

    A modified description of the scheduled action.

  • :start_time (Time)

    A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

  • :end_time (Time)

    A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

  • :enable (Boolean)

    A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

Returns:

See Also:

#modify_snapshot_copy_retention_period(options = {}) ⇒ Types::ModifySnapshotCopyRetentionPeriodResult

Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Examples:

Request syntax with placeholder values


resp = client.modify_snapshot_copy_retention_period({
  cluster_identifier: "String", # required
  retention_period: 1, # required
  manual: false,
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

    Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

  • :retention_period (required, Integer)

    The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

    By default, this only changes the retention period of copied automated snapshots.

    If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

    Constraints: Must be at least 1 and no more than 35 for automated snapshots.

    If you specify the manual option, only newly copied manual snapshots will have the new retention period.

    If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

    Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

  • :manual (Boolean)

    Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Returns:

See Also:

#modify_snapshot_schedule(options = {}) ⇒ Types::SnapshotSchedule

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

Examples:

Request syntax with placeholder values


resp = client.modify_snapshot_schedule({
  schedule_identifier: "String", # required
  schedule_definitions: ["String"], # required
})

Response structure


resp.schedule_definitions #=> Array
resp.schedule_definitions[0] #=> String
resp.schedule_identifier #=> String
resp.schedule_description #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.next_invocations #=> Array
resp.next_invocations[0] #=> Time
resp.associated_cluster_count #=> Integer
resp.associated_clusters #=> Array
resp.associated_clusters[0].cluster_identifier #=> String
resp.associated_clusters[0].schedule_association_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"

Options Hash (options):

  • :schedule_identifier (required, String)

    A unique alphanumeric identifier of the schedule to modify.

  • :schedule_definitions (required, Array<String>)

    An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, \"cron(30 12 *)\" or \"rate(12 hours)\".

Returns:

See Also:

#modify_usage_limit(options = {}) ⇒ Types::UsageLimit

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Examples:

Request syntax with placeholder values


resp = client.modify_usage_limit({
  usage_limit_id: "String", # required
  amount: 1,
  breach_action: "log", # accepts log, emit-metric, disable
})

Response structure


resp.usage_limit_id #=> String
resp.cluster_identifier #=> String
resp.feature_type #=> String, one of "spectrum", "concurrency-scaling"
resp.limit_type #=> String, one of "time", "data-scanned"
resp.amount #=> Integer
resp.period #=> String, one of "daily", "weekly", "monthly"
resp.breach_action #=> String, one of "log", "emit-metric", "disable"
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :usage_limit_id (required, String)

    The identifier of the usage limit to modify.

  • :amount (Integer)

    The new limit amount. For more information about this parameter, see UsageLimit.

  • :breach_action (String)

    The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.

Returns:

See Also:

#pause_cluster(options = {}) ⇒ Types::PauseClusterResult

Pauses a cluster.

Examples:

Request syntax with placeholder values


resp = client.pause_cluster({
  cluster_identifier: "String", # required
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster to be paused.

Returns:

See Also:

#purchase_reserved_node_offering(options = {}) ⇒ Types::PurchaseReservedNodeOfferingResult

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.purchase_reserved_node_offering({
  reserved_node_offering_id: "String", # required
  node_count: 1,
})

Response structure


resp.reserved_node.reserved_node_id #=> String
resp.reserved_node.reserved_node_offering_id #=> String
resp.reserved_node.node_type #=> String
resp.reserved_node.start_time #=> Time
resp.reserved_node.duration #=> Integer
resp.reserved_node.fixed_price #=> Float
resp.reserved_node.usage_price #=> Float
resp.reserved_node.currency_code #=> String
resp.reserved_node.node_count #=> Integer
resp.reserved_node.state #=> String
resp.reserved_node.offering_type #=> String
resp.reserved_node.recurring_charges #=> Array
resp.reserved_node.recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_node.recurring_charges[0].recurring_charge_frequency #=> String
resp.reserved_node.reserved_node_offering_type #=> String, one of "Regular", "Upgradable"

Options Hash (options):

  • :reserved_node_offering_id (required, String)

    The unique identifier of the reserved node offering you want to purchase.

  • :node_count (Integer)

    The number of reserved nodes that you want to purchase.

    Default: 1

Returns:

See Also:

#reboot_cluster(options = {}) ⇒ Types::RebootClusterResult

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.reboot_cluster({
  cluster_identifier: "String", # required
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The cluster identifier.

Returns:

See Also:

#reset_cluster_parameter_group(options = {}) ⇒ Types::ClusterParameterGroupNameMessage

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

Examples:

Request syntax with placeholder values


resp = client.reset_cluster_parameter_group({
  parameter_group_name: "String", # required
  reset_all_parameters: false,
  parameters: [
    {
      parameter_name: "String",
      parameter_value: "String",
      description: "String",
      source: "String",
      data_type: "String",
      allowed_values: "String",
      apply_type: "static", # accepts static, dynamic
      is_modifiable: false,
      minimum_engine_version: "String",
    },
  ],
})

Response structure


resp.parameter_group_name #=> String
resp.parameter_group_status #=> String

Options Hash (options):

  • :parameter_group_name (required, String)

    The name of the cluster parameter group to be reset.

  • :reset_all_parameters (Boolean)

    If true, all parameters in the specified parameter group will be reset to their default values.

    Default: true

  • :parameters (Array<Types::Parameter>)

    An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

    Constraints: A maximum of 20 parameters can be reset in a single request.

Returns:

See Also:

#resize_cluster(options = {}) ⇒ Types::ResizeClusterResult

Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.

Elastic resize operations have the following restrictions:

  • You can only resize clusters of the following types:

    • dc1.large (if your cluster is in a VPC)

    • dc1.8xlarge (if your cluster is in a VPC)

    • dc2.large

    • dc2.8xlarge

    • ds2.xlarge

    • ds2.8xlarge

    • ra3.4xlarge

    • ra3.16xlarge

  • The type of nodes that you add must match the node type for the cluster.

Examples:

Request syntax with placeholder values


resp = client.resize_cluster({
  cluster_identifier: "String", # required
  cluster_type: "String",
  node_type: "String",
  number_of_nodes: 1,
  classic: false,
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier for the cluster to resize.

  • :cluster_type (String)

    The new cluster type for the specified cluster.

  • :node_type (String)

    The new node type for the nodes you are adding. If not specified, the cluster\'s current node type is used.

  • :number_of_nodes (Integer)

    The new number of nodes for the cluster. If not specified, the cluster\'s current number of nodes is used.

  • :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.

Returns:

See Also:

#restore_from_cluster_snapshot(options = {}) ⇒ Types::RestoreFromClusterSnapshotResult

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.restore_from_cluster_snapshot({
  cluster_identifier: "String", # required
  snapshot_identifier: "String", # required
  snapshot_cluster_identifier: "String",
  port: 1,
  availability_zone: "String",
  allow_version_upgrade: false,
  cluster_subnet_group_name: "String",
  publicly_accessible: false,
  owner_account: "String",
  hsm_client_certificate_identifier: "String",
  hsm_configuration_identifier: "String",
  elastic_ip: "String",
  cluster_parameter_group_name: "String",
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  automated_snapshot_retention_period: 1,
  manual_snapshot_retention_period: 1,
  kms_key_id: "String",
  node_type: "String",
  enhanced_vpc_routing: false,
  additional_info: "String",
  iam_roles: ["String"],
  maintenance_track_name: "String",
  snapshot_schedule_identifier: "String",
  number_of_nodes: 1,
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster that will be created from restoring the snapshot.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

  • :snapshot_identifier (required, String)

    The name of the snapshot from which to create the new cluster. This parameter isn\'t case sensitive.

    Example: my-snapshot-id

  • :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.

  • :port (Integer)

    The port number on which the cluster accepts connections.

    Default: The same port as the original cluster.

    Constraints: Must be between 1115 and 65535.

  • :availability_zone (String)

    The Amazon EC2 Availability Zone in which to restore the cluster.

    Default: A random, system-chosen Availability Zone.

    Example: us-east-2a

  • :allow_version_upgrade (Boolean)

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

    Default: true

  • :cluster_subnet_group_name (String)

    The name of the subnet group where you want to cluster restored.

    A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

  • :publicly_accessible (Boolean)

    If true, the cluster can be accessed from a public network.

  • :owner_account (String)

    The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

  • :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.

  • :elastic_ip (String)

    The elastic IP (EIP) address for the cluster.

  • :cluster_parameter_group_name (String)

    The name of the parameter group to be associated with this cluster.

    Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

  • :cluster_security_groups (Array<String>)

    A list of security groups to be associated with this cluster.

    Default: The default cluster security group for Amazon Redshift.

    Cluster security groups only apply to clusters outside of VPCs.

  • :vpc_security_group_ids (Array<String>)

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Default: The default VPC security group is associated with the cluster.

    VPC security groups only apply to clusters in VPCs.

  • :preferred_maintenance_window (String)

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Minimum 30-minute window.

  • :automated_snapshot_retention_period (Integer)

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    Default: The value selected for the cluster from which the snapshot was taken.

    Constraints: Must be a value from 0 to 35.

  • :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.

    The value must be either -1 or an integer between 1 and 3,653.

  • :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 that you restore from a shared snapshot.

  • :node_type (String)

    The node type that the restored cluster will be provisioned with.

    Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can\'t restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

  • :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.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

  • :additional_info (String)

    Reserved.

  • :iam_roles (Array<String>)

    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 10 IAM roles in a single request.

    A cluster can have up to 10 IAM roles associated at any time.

  • :maintenance_track_name (String)

    The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

  • :snapshot_schedule_identifier (String)

    A unique identifier for the snapshot schedule.

  • :number_of_nodes (Integer)

    The number of nodes specified when provisioning the restored cluster.

Returns:

See Also:

#restore_table_from_cluster_snapshot(options = {}) ⇒ Types::RestoreTableFromClusterSnapshotResult

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

Examples:

Request syntax with placeholder values


resp = client.restore_table_from_cluster_snapshot({
  cluster_identifier: "String", # required
  snapshot_identifier: "String", # required
  source_database_name: "String", # required
  source_schema_name: "String",
  source_table_name: "String", # required
  target_database_name: "String",
  target_schema_name: "String",
  new_table_name: "String", # required
})

Response structure


resp.table_restore_status.table_restore_request_id #=> String
resp.table_restore_status.status #=> String, one of "PENDING", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED"
resp.table_restore_status.message #=> String
resp.table_restore_status.request_time #=> Time
resp.table_restore_status.progress_in_mega_bytes #=> Integer
resp.table_restore_status.total_data_in_mega_bytes #=> Integer
resp.table_restore_status.cluster_identifier #=> String
resp.table_restore_status.snapshot_identifier #=> String
resp.table_restore_status.source_database_name #=> String
resp.table_restore_status.source_schema_name #=> String
resp.table_restore_status.source_table_name #=> String
resp.table_restore_status.target_database_name #=> String
resp.table_restore_status.target_schema_name #=> String
resp.table_restore_status.new_table_name #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the Amazon Redshift cluster to restore the table to.

  • :snapshot_identifier (required, String)

    The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

  • :source_database_name (required, String)

    The name of the source database that contains the table to restore from.

  • :source_schema_name (String)

    The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

  • :source_table_name (required, String)

    The name of the source table to restore from.

  • :target_database_name (String)

    The name of the database to restore the table to.

  • :target_schema_name (String)

    The name of the schema to restore the table to.

  • :new_table_name (required, String)

    The name of the table to create as a result of the current request.

Returns:

See Also:

#resume_cluster(options = {}) ⇒ Types::ResumeClusterResult

Resumes a paused cluster.

Examples:

Request syntax with placeholder values


resp = client.resume_cluster({
  cluster_identifier: "String", # required
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The identifier of the cluster to be resumed.

Returns:

See Also:

#revoke_cluster_security_group_ingress(options = {}) ⇒ Types::RevokeClusterSecurityGroupIngressResult

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.revoke_cluster_security_group_ingress({
  cluster_security_group_name: "String", # required
  cidrip: "String",
  ec2_security_group_name: "String",
  ec2_security_group_owner_id: "String",
})

Response structure


resp.cluster_security_group.cluster_security_group_name #=> String
resp.cluster_security_group.description #=> String
resp.cluster_security_group.ec2_security_groups #=> Array
resp.cluster_security_group.ec2_security_groups[0].status #=> String
resp.cluster_security_group.ec2_security_groups[0].ec2_security_group_name #=> String
resp.cluster_security_group.ec2_security_groups[0].ec2_security_group_owner_id #=> String
resp.cluster_security_group.ec2_security_groups[0].tags #=> Array
resp.cluster_security_group.ec2_security_groups[0].tags[0].key #=> String
resp.cluster_security_group.ec2_security_groups[0].tags[0].value #=> String
resp.cluster_security_group.ip_ranges #=> Array
resp.cluster_security_group.ip_ranges[0].status #=> String
resp.cluster_security_group.ip_ranges[0].cidrip #=> String
resp.cluster_security_group.ip_ranges[0].tags #=> Array
resp.cluster_security_group.ip_ranges[0].tags[0].key #=> String
resp.cluster_security_group.ip_ranges[0].tags[0].value #=> String
resp.cluster_security_group.tags #=> Array
resp.cluster_security_group.tags[0].key #=> String
resp.cluster_security_group.tags[0].value #=> String

Options Hash (options):

  • :cluster_security_group_name (required, String)

    The name of the security Group from which to revoke the ingress rule.

  • :cidrip (String)

    The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

  • :ec2_security_group_name (String)

    The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

  • :ec2_security_group_owner_id (String)

    The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

    Example: 111122223333

Returns:

See Also:

#revoke_snapshot_access(options = {}) ⇒ Types::RevokeSnapshotAccessResult

Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.revoke_snapshot_access({
  snapshot_identifier: "String", # required
  snapshot_cluster_identifier: "String",
  account_with_restore_access: "String", # required
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> true/false
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> true/false
resp.snapshot.accounts_with_restore_access #=> Array
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot.accounts_with_restore_access[0]. #=> String
resp.snapshot. #=> String
resp.snapshot.total_backup_size_in_mega_bytes #=> Float
resp.snapshot.actual_incremental_backup_size_in_mega_bytes #=> Float
resp.snapshot.backup_progress_in_mega_bytes #=> Float
resp.snapshot.current_backup_rate_in_mega_bytes_per_second #=> Float
resp.snapshot.estimated_seconds_to_completion #=> Integer
resp.snapshot.elapsed_time_in_seconds #=> Integer
resp.snapshot.source_region #=> String
resp.snapshot.tags #=> Array
resp.snapshot.tags[0].key #=> String
resp.snapshot.tags[0].value #=> String
resp.snapshot.restorable_node_types #=> Array
resp.snapshot.restorable_node_types[0] #=> String
resp.snapshot.enhanced_vpc_routing #=> true/false
resp.snapshot.maintenance_track_name #=> String
resp.snapshot.manual_snapshot_retention_period #=> Integer
resp.snapshot.manual_snapshot_remaining_days #=> Integer
resp.snapshot.snapshot_retention_start_time #=> Time

Options Hash (options):

  • :snapshot_identifier (required, String)

    The identifier of the snapshot that the account can no longer access.

  • :snapshot_cluster_identifier (String)

    The identifier of the cluster the 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.

  • :account_with_restore_access (required, String)

    The identifier of the AWS customer account that can no longer restore the specified snapshot.

Returns:

See Also:

#rotate_encryption_key(options = {}) ⇒ Types::RotateEncryptionKeyResult

Rotates the encryption keys for a cluster.

Examples:

Request syntax with placeholder values


resp = client.rotate_encryption_key({
  cluster_identifier: "String", # required
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.cluster_availability_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_security_groups #=> Array
resp.cluster.cluster_security_groups[0].cluster_security_group_name #=> String
resp.cluster.cluster_security_groups[0].status #=> String
resp.cluster.vpc_security_groups #=> Array
resp.cluster.vpc_security_groups[0].vpc_security_group_id #=> String
resp.cluster.vpc_security_groups[0].status #=> String
resp.cluster.cluster_parameter_groups #=> Array
resp.cluster.cluster_parameter_groups[0].parameter_group_name #=> String
resp.cluster.cluster_parameter_groups[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list #=> Array
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_name #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_status #=> String
resp.cluster.cluster_parameter_groups[0].cluster_parameter_status_list[0].parameter_apply_error_description #=> String
resp.cluster.cluster_subnet_group_name #=> String
resp.cluster.vpc_id #=> String
resp.cluster.availability_zone #=> String
resp.cluster.preferred_maintenance_window #=> String
resp.cluster.pending_modified_values.master_user_password #=> String
resp.cluster.pending_modified_values.node_type #=> String
resp.cluster.pending_modified_values.number_of_nodes #=> Integer
resp.cluster.pending_modified_values.cluster_type #=> String
resp.cluster.pending_modified_values.cluster_version #=> String
resp.cluster.pending_modified_values.automated_snapshot_retention_period #=> Integer
resp.cluster.pending_modified_values.cluster_identifier #=> String
resp.cluster.pending_modified_values.publicly_accessible #=> true/false
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> true/false
resp.cluster.pending_modified_values.maintenance_track_name #=> String
resp.cluster.pending_modified_values.encryption_type #=> String
resp.cluster.cluster_version #=> String
resp.cluster.allow_version_upgrade #=> true/false
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> true/false
resp.cluster.encrypted #=> true/false
resp.cluster.restore_status.status #=> String
resp.cluster.restore_status.current_restore_rate_in_mega_bytes_per_second #=> Float
resp.cluster.restore_status.snapshot_size_in_mega_bytes #=> Integer
resp.cluster.restore_status.progress_in_mega_bytes #=> Integer
resp.cluster.restore_status.elapsed_time_in_seconds #=> Integer
resp.cluster.restore_status.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.status #=> String
resp.cluster.data_transfer_progress.current_rate_in_mega_bytes_per_second #=> Float
resp.cluster.data_transfer_progress.total_data_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.data_transferred_in_mega_bytes #=> Integer
resp.cluster.data_transfer_progress.estimated_time_to_completion_in_seconds #=> Integer
resp.cluster.data_transfer_progress.elapsed_time_in_seconds #=> Integer
resp.cluster.hsm_status.hsm_client_certificate_identifier #=> String
resp.cluster.hsm_status.hsm_configuration_identifier #=> String
resp.cluster.hsm_status.status #=> String
resp.cluster.cluster_snapshot_copy_status.destination_region #=> String
resp.cluster.cluster_snapshot_copy_status.retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.manual_snapshot_retention_period #=> Integer
resp.cluster.cluster_snapshot_copy_status.snapshot_copy_grant_name #=> String
resp.cluster.cluster_public_key #=> String
resp.cluster.cluster_nodes #=> Array
resp.cluster.cluster_nodes[0].node_role #=> String
resp.cluster.cluster_nodes[0].private_ip_address #=> String
resp.cluster.cluster_nodes[0].public_ip_address #=> String
resp.cluster.elastic_ip_status.elastic_ip #=> String
resp.cluster.elastic_ip_status.status #=> String
resp.cluster.cluster_revision_number #=> String
resp.cluster.tags #=> Array
resp.cluster.tags[0].key #=> String
resp.cluster.tags[0].value #=> String
resp.cluster.kms_key_id #=> String
resp.cluster.enhanced_vpc_routing #=> true/false
resp.cluster.iam_roles #=> Array
resp.cluster.iam_roles[0].iam_role_arn #=> String
resp.cluster.iam_roles[0].apply_status #=> String
resp.cluster.pending_actions #=> Array
resp.cluster.pending_actions[0] #=> String
resp.cluster.maintenance_track_name #=> String
resp.cluster.elastic_resize_number_of_node_options #=> String
resp.cluster.deferred_maintenance_windows #=> Array
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_identifier #=> String
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_start_time #=> Time
resp.cluster.deferred_maintenance_windows[0].defer_maintenance_end_time #=> Time
resp.cluster.snapshot_schedule_identifier #=> String
resp.cluster.snapshot_schedule_state #=> String, one of "MODIFYING", "ACTIVE", "FAILED"
resp.cluster.expected_next_snapshot_schedule_time #=> Time
resp.cluster.expected_next_snapshot_schedule_time_status #=> String
resp.cluster.next_maintenance_window_start_time #=> Time
resp.cluster.resize_info.resize_type #=> String
resp.cluster.resize_info.allow_cancel_resize #=> true/false
resp.cluster.cluster_namespace_arn #=> String

Options Hash (options):

  • :cluster_identifier (required, String)

    The unique identifier of the cluster that you want to rotate the encryption keys for.

    Constraints: Must be the name of valid cluster that has encryption enabled.

Returns:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {})

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:
:cluster_available#describe_clusters6030
:cluster_deleted#describe_clusters6030
:cluster_restored#describe_clusters6030
:snapshot_available#describe_cluster_snapshots1520

Returns:

  • (Array<Symbol>)

    the list of supported waiters.