Class: Aws::Redshift::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Redshift::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Redshift::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#accept_reserved_node_exchange(params = {}) ⇒ 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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



525
526
527
528
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 525

def accept_reserved_node_exchange(params = {}, options = {})
  req = build_request(:accept_reserved_node_exchange, params)
  req.send_request(options)
end

#add_partner(params = {}) ⇒ Types::PartnerIntegrationOutputMessage

Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.

Examples:

Request syntax with placeholder values


resp = client.add_partner({
  account_id: "PartnerIntegrationAccountId", # required
  cluster_identifier: "PartnerIntegrationClusterIdentifier", # required
  database_name: "PartnerIntegrationDatabaseName", # required
  partner_name: "PartnerIntegrationPartnerName", # required
})

Response structure


resp.database_name #=> String
resp.partner_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the cluster.

  • :cluster_identifier (required, String) —

    The cluster identifier of the cluster that receives data from the partner.

  • :database_name (required, String) —

    The name of the database that receives data from the partner.

  • :partner_name (required, String) —

    The name of the partner that is authorized to send data.

Returns:

See Also:



571
572
573
574
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 571

def add_partner(params = {}, options = {})
  req = build_request(:add_partner, params)
  req.send_request(options)
end

#associate_data_share_consumer(params = {}) ⇒ Types::DataShare

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

Examples:

Request syntax with placeholder values


resp = client.associate_data_share_consumer({
  data_share_arn: "String", # required
  associate_entire_account: false,
  consumer_arn: "String",
  consumer_region: "String",
  allow_writes: false,
})

Response structure


resp.data_share_arn #=> String
resp.producer_arn #=> String
resp.allow_publicly_accessible_consumers #=> Boolean
resp.data_share_associations #=> Array
resp.data_share_associations[0].consumer_identifier #=> String
resp.data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_share_associations[0].consumer_region #=> String
resp.data_share_associations[0].created_date #=> Time
resp.data_share_associations[0].status_change_date #=> Time
resp.data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.managed_by #=> String
resp.data_share_type #=> String, one of "INTERNAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_share_arn (required, String) —

    The Amazon Resource Name (ARN) of the datashare that the consumer is to use.

  • :associate_entire_account (Boolean) —

    A value that specifies whether the datashare is associated with the entire account.

  • :consumer_arn (String) —

    The Amazon Resource Name (ARN) of the consumer namespace associated with the datashare.

  • :consumer_region (String) —

    From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

  • :allow_writes (Boolean) —

    If set to true, allows write operations for a datashare.

Returns:

See Also:



640
641
642
643
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 640

def associate_data_share_consumer(params = {}, options = {})
  req = build_request(:associate_data_share_consumer, params)
  req.send_request(options)
end

#authorize_cluster_security_group_ingress(params = {}) ⇒ 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 Amazon Web Services 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access Key ID is not an acceptable value.

    Example: 111122223333

Returns:

See Also:



726
727
728
729
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 726

def authorize_cluster_security_group_ingress(params = {}, options = {})
  req = build_request(:authorize_cluster_security_group_ingress, params)
  req.send_request(options)
end

#authorize_data_share(params = {}) ⇒ Types::DataShare

From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account must have the correct access permissions.

Examples:

Request syntax with placeholder values


resp = client.authorize_data_share({
  data_share_arn: "String", # required
  consumer_identifier: "String", # required
  allow_writes: false,
})

Response structure


resp.data_share_arn #=> String
resp.producer_arn #=> String
resp.allow_publicly_accessible_consumers #=> Boolean
resp.data_share_associations #=> Array
resp.data_share_associations[0].consumer_identifier #=> String
resp.data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_share_associations[0].consumer_region #=> String
resp.data_share_associations[0].created_date #=> Time
resp.data_share_associations[0].status_change_date #=> Time
resp.data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.managed_by #=> String
resp.data_share_type #=> String, one of "INTERNAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_share_arn (required, String) —

    The Amazon Resource Name (ARN) of the datashare namespace that producers are to authorize sharing for.

  • :consumer_identifier (required, String) —

    The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

  • :allow_writes (Boolean) —

    If set to true, allows write operations for a datashare.

Returns:

See Also:



785
786
787
788
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 785

def authorize_data_share(params = {}, options = {})
  req = build_request(:authorize_data_share, params)
  req.send_request(options)
end

#authorize_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization

Grants access to a cluster.

Examples:

Request syntax with placeholder values


resp = client.authorize_endpoint_access({
  cluster_identifier: "String",
  account: "String", # required
  vpc_ids: ["String"],
})

Response structure


resp.grantor #=> String
resp.grantee #=> String
resp.cluster_identifier #=> String
resp.authorize_time #=> Time
resp.cluster_status #=> String
resp.status #=> String, one of "Authorized", "Revoking"
resp.allowed_all_vp_cs #=> Boolean
resp.allowed_vp_cs #=> Array
resp.allowed_vp_cs[0] #=> String
resp.endpoint_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier of the cluster to grant access to.

  • :account (required, String) —

    The Amazon Web Services account ID to grant access to.

  • :vpc_ids (Array<String>) —

    The virtual private cloud (VPC) identifiers to grant access to.

Returns:

See Also:



838
839
840
841
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 838

def authorize_endpoint_access(params = {}, options = {})
  req = build_request(:authorize_endpoint_access, params)
  req.send_request(options)
end

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

Authorizes the specified Amazon Web Services 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",
  snapshot_arn: "String",
  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.engine_full_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 #=> Boolean
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshot.master_password_secret_arn #=> String
resp.snapshot.master_password_secret_kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_identifier (String) —

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

  • :snapshot_arn (String) —

    The Amazon Resource Name (ARN) of the snapshot to authorize access to.

  • :snapshot_cluster_identifier (String) —

    The identifier of the cluster the snapshot was created from.

    • If the snapshot to access doesn't exist and the associated IAM policy doesn't allow access to all () snapshots* - This parameter is required. Otherwise, permissions aren't available to check if the snapshot exists.

    • If the snapshot to access exists - This parameter isn't required. Redshift can retrieve the cluster identifier and use it to validate snapshot authorization.

  • :account_with_restore_access (required, String) —

    The identifier of the Amazon Web Services account authorized to restore the specified snapshot.

    To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.

Returns:

See Also:



941
942
943
944
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 941

def authorize_snapshot_access(params = {}, options = {})
  req = build_request(:authorize_snapshot_access, params)
  req.send_request(options)
end

#batch_delete_cluster_snapshots(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



981
982
983
984
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 981

def batch_delete_cluster_snapshots(params = {}, options = {})
  req = build_request(:batch_delete_cluster_snapshots, params)
  req.send_request(options)
end

#batch_modify_cluster_snapshots(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



1033
1034
1035
1036
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1033

def batch_modify_cluster_snapshots(params = {}, options = {})
  req = build_request(:batch_modify_cluster_snapshots, params)
  req.send_request(options)
end

#cancel_resize(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

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

Returns:

See Also:



1095
1096
1097
1098
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1095

def cancel_resize(params = {}, options = {})
  req = build_request(:cancel_resize, params)
  req.send_request(options)
end

#copy_cluster_snapshot(params = {}) ⇒ 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.engine_full_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 #=> Boolean
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshot.master_password_secret_arn #=> String
resp.snapshot.master_password_secret_kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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:



1227
1228
1229
1230
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1227

def copy_cluster_snapshot(params = {}, options = {})
  req = build_request(:copy_cluster_snapshot, params)
  req.send_request(options)
end

#create_authentication_profile(params = {}) ⇒ Types::CreateAuthenticationProfileResult

Creates an authentication profile with the specified parameters.

Examples:

Request syntax with placeholder values


resp = client.create_authentication_profile({
  authentication_profile_name: "AuthenticationProfileNameString", # required
  authentication_profile_content: "String", # required
})

Response structure


resp.authentication_profile_name #=> String
resp.authentication_profile_content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authentication_profile_name (required, String) —

    The name of the authentication profile to be created.

  • :authentication_profile_content (required, String) —

    The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

Returns:

See Also:



1262
1263
1264
1265
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1262

def create_authentication_profile(params = {}, options = {})
  req = build_request(:create_authentication_profile, params)
  req.send_request(options)
end

#create_cluster(params = {}) ⇒ 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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:

  • Creating a public cluster

  • Restoring a public cluster

  • Modifying a private cluster to be public

  • Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User 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: "SensitiveString",
  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",
  availability_zone_relocation: false,
  aqua_configuration_status: "enabled", # accepts enabled, disabled, auto
  default_iam_role_arn: "String",
  load_sample_data: "String",
  manage_master_password: false,
  master_password_secret_kms_key_id: "String",
  ip_address_type: "String",
  multi_az: false,
  redshift_idc_application_arn: "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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

  • :master_username (required, String) —

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

    Constraints:

    • Must be 1 - 128 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.

    • The first character must be a letter.

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

    • 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 (String) —

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

    You can't use MasterUserPassword if ManageMasterPassword is true.

    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-126) except ' (single quote), " (double quote), `,/, or@`.

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

    You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

    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:

    • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)

    • For clusters with dc2 nodes - Select a port within the range 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.

    Default: false

  • :encrypted (Boolean) —

    If true, the data in the cluster is encrypted at rest. If you set the value on this parameter to false, the request will fail.

    Default: true

  • :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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. 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 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

    The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

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

  • :availability_zone_relocation (Boolean) —

    The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

  • :aqua_configuration_status (String) —

    This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

  • :default_iam_role_arn (String) —

    The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

  • :load_sample_data (String) —

    A flag that specifies whether to load sample data once the cluster is created.

  • :manage_master_password (Boolean) —

    If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

  • :master_password_secret_kms_key_id (String) —

    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

  • :ip_address_type (String) —

    The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

  • :multi_az (Boolean) —

    If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

  • :redshift_idc_application_arn (String) —

    The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

Returns:

See Also:



1876
1877
1878
1879
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1876

def create_cluster(params = {}, options = {})
  req = build_request(:create_cluster, params)
  req.send_request(options)
end

#create_cluster_parameter_group(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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 Amazon Web Services 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:



1965
1966
1967
1968
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1965

def create_cluster_parameter_group(params = {}, options = {})
  req = build_request(:create_cluster_parameter_group, params)
  req.send_request(options)
end

#create_cluster_security_group(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services account.

    Example: examplesecuritygroup

  • :description (required, String) —

    A description for the security group.

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

    A list of tag instances.

Returns:

See Also:



2044
2045
2046
2047
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2044

def create_cluster_security_group(params = {}, options = {})
  req = build_request(:create_cluster_security_group, params)
  req.send_request(options)
end

#create_cluster_snapshot(params = {}) ⇒ 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.engine_full_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 #=> Boolean
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshot.master_password_secret_arn #=> String
resp.snapshot.master_password_secret_kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_identifier (required, String) —

    A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services 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:



2158
2159
2160
2161
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2158

def create_cluster_snapshot(params = {}, options = {})
  req = build_request(:create_cluster_snapshot, params)
  req.send_request(options)
end

#create_cluster_subnet_group(params = {}) ⇒ 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
resp.cluster_subnet_group.supported_cluster_ip_address_types #=> Array
resp.cluster_subnet_group.supported_cluster_ip_address_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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:



2239
2240
2241
2242
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2239

def create_cluster_subnet_group(params = {}, options = {})
  req = build_request(:create_cluster_subnet_group, params)
  req.send_request(options)
end

#create_custom_domain_association(params = {}) ⇒ Types::CreateCustomDomainAssociationResult

Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).

Examples:

Request syntax with placeholder values


resp = client.create_custom_domain_association({
  custom_domain_name: "CustomDomainNameString", # required
  custom_domain_certificate_arn: "CustomDomainCertificateArnString", # required
  cluster_identifier: "String", # required
})

Response structure


resp.custom_domain_name #=> String
resp.custom_domain_certificate_arn #=> String
resp.cluster_identifier #=> String
resp.custom_domain_cert_expiry_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_domain_name (required, String) —

    The custom domain name for a custom domain association.

  • :custom_domain_certificate_arn (required, String) —

    The certificate Amazon Resource Name (ARN) for the custom domain name association.

  • :cluster_identifier (required, String) —

    The cluster identifier that the custom domain is associated with.

Returns:

See Also:



2284
2285
2286
2287
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2284

def create_custom_domain_association(params = {}, options = {})
  req = build_request(:create_custom_domain_association, params)
  req.send_request(options)
end

#create_endpoint_access(params = {}) ⇒ Types::EndpointAccess

Creates a Redshift-managed VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_endpoint_access({
  cluster_identifier: "String",
  resource_owner: "String",
  endpoint_name: "String", # required
  subnet_group_name: "String", # required
  vpc_security_group_ids: ["String"],
})

Response structure


resp.cluster_identifier #=> String
resp.resource_owner #=> String
resp.subnet_group_name #=> String
resp.endpoint_status #=> String
resp.endpoint_name #=> String
resp.endpoint_create_time #=> Time
resp.port #=> Integer
resp.address #=> String
resp.vpc_security_groups #=> Array
resp.vpc_security_groups[0].vpc_security_group_id #=> String
resp.vpc_security_groups[0].status #=> String
resp.vpc_endpoint.vpc_endpoint_id #=> String
resp.vpc_endpoint.vpc_id #=> String
resp.vpc_endpoint.network_interfaces #=> Array
resp.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.vpc_endpoint.network_interfaces[0].ipv_6_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier of the cluster to access.

  • :resource_owner (String) —

    The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

  • :endpoint_name (required, String) —

    The Redshift-managed VPC endpoint name.

    An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

  • :subnet_group_name (required, String) —

    The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

  • :vpc_security_group_ids (Array<String>) —

    The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Returns:

See Also:



2363
2364
2365
2366
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2363

def create_endpoint_access(params = {}, options = {})
  req = build_request(:create_endpoint_access, params)
  req.send_request(options)
end

#create_event_subscription(params = {}) ⇒ 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 Amazon Web Services 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 Amazon Web Services 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 #=> Boolean
resp.event_subscription.tags #=> Array
resp.event_subscription.tags[0].key #=> String
resp.event_subscription.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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, pending

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



2498
2499
2500
2501
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2498

def create_event_subscription(params = {}, options = {})
  req = build_request(:create_event_subscription, params)
  req.send_request(options)
end

#create_hsm_client_certificate(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



2554
2555
2556
2557
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2554

def create_hsm_client_certificate(params = {}, options = {})
  req = build_request(:create_hsm_client_certificate, params)
  req.send_request(options)
end

#create_hsm_configuration(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



2633
2634
2635
2636
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2633

def create_hsm_configuration(params = {}, options = {})
  req = build_request(:create_hsm_configuration, params)
  req.send_request(options)
end

#create_integration(params = {}) ⇒ Types::Integration

Creates a zero-ETL integration or S3 event integration with Amazon Redshift.

Examples:

Request syntax with placeholder values


resp = client.create_integration({
  source_arn: "SourceArn", # required
  target_arn: "TargetArn", # required
  integration_name: "IntegrationName", # required
  kms_key_id: "String",
  tag_list: [
    {
      key: "String",
      value: "String",
    },
  ],
  additional_encryption_context: {
    "String" => "String",
  },
  description: "IntegrationDescription",
})

Response structure


resp.integration_arn #=> String
resp.integration_name #=> String
resp.source_arn #=> String
resp.target_arn #=> String
resp.status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention"
resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.create_time #=> Time
resp.description #=> String
resp.kms_key_id #=> String
resp.additional_encryption_context #=> Hash
resp.additional_encryption_context["String"] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_arn (required, String) —

    The Amazon Resource Name (ARN) of the database to use as the source for replication.

  • :target_arn (required, String) —

    The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

  • :integration_name (required, String) —

    The name of the integration.

  • :kms_key_id (String) —

    An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.

  • :tag_list (Array<Types::Tag>) —

    A list of tags.

  • :additional_encryption_context (Hash<String,String>) —

    An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.

    You can only include this parameter if you specify the KMSKeyId parameter.

  • :description (String) —

    A description of the integration.

Returns:

See Also:



2732
2733
2734
2735
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2732

def create_integration(params = {}, options = {})
  req = build_request(:create_integration, params)
  req.send_request(options)
end

#create_redshift_idc_application(params = {}) ⇒ Types::CreateRedshiftIdcApplicationResult

Creates an Amazon Redshift application for use with IAM Identity Center.

Examples:

Request syntax with placeholder values


resp = client.create_redshift_idc_application({
  idc_instance_arn: "String", # required
  redshift_idc_application_name: "RedshiftIdcApplicationName", # required
  identity_namespace: "IdentityNamespaceString",
  idc_display_name: "IdcDisplayNameString", # required
  iam_role_arn: "String", # required
  authorized_token_issuer_list: [
    {
      trusted_token_issuer_arn: "String",
      authorized_audiences_list: ["String"],
    },
  ],
  service_integrations: [
    {
      lake_formation: [
        {
          lake_formation_query: {
            authorization: "Enabled", # required, accepts Enabled, Disabled
          },
        },
      ],
      s3_access_grants: [
        {
          read_write_access: {
            authorization: "Enabled", # required, accepts Enabled, Disabled
          },
        },
      ],
    },
  ],
})

Response structure


resp.redshift_idc_application.idc_instance_arn #=> String
resp.redshift_idc_application.redshift_idc_application_name #=> String
resp.redshift_idc_application.redshift_idc_application_arn #=> String
resp.redshift_idc_application.identity_namespace #=> String
resp.redshift_idc_application.idc_display_name #=> String
resp.redshift_idc_application.iam_role_arn #=> String
resp.redshift_idc_application.idc_managed_application_arn #=> String
resp.redshift_idc_application.idc_onboard_status #=> String
resp.redshift_idc_application.authorized_token_issuer_list #=> Array
resp.redshift_idc_application.authorized_token_issuer_list[0].trusted_token_issuer_arn #=> String
resp.redshift_idc_application.authorized_token_issuer_list[0].authorized_audiences_list #=> Array
resp.redshift_idc_application.authorized_token_issuer_list[0].authorized_audiences_list[0] #=> String
resp.redshift_idc_application.service_integrations #=> Array
resp.redshift_idc_application.service_integrations[0].lake_formation #=> Array
resp.redshift_idc_application.service_integrations[0].lake_formation[0].lake_formation_query.authorization #=> String, one of "Enabled", "Disabled"
resp.redshift_idc_application.service_integrations[0].s3_access_grants #=> Array
resp.redshift_idc_application.service_integrations[0].s3_access_grants[0].read_write_access.authorization #=> String, one of "Enabled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :idc_instance_arn (required, String) —

    The Amazon resource name (ARN) of the IAM Identity Center instance where Amazon Redshift creates a new managed application.

  • :redshift_idc_application_name (required, String) —

    The name of the Redshift application in IAM Identity Center.

  • :identity_namespace (String) —

    The namespace for the Amazon Redshift IAM Identity Center application instance. It determines which managed application verifies the connection token.

  • :idc_display_name (required, String) —

    The display name for the Amazon Redshift IAM Identity Center application instance. It appears in the console.

  • :iam_role_arn (required, String) —

    The IAM role ARN for the Amazon Redshift IAM Identity Center application instance. It has the required permissions to be assumed and invoke the IDC Identity Center API.

  • :authorized_token_issuer_list (Array<Types::AuthorizedTokenIssuer>) —

    The token issuer list for the Amazon Redshift IAM Identity Center application instance.

  • :service_integrations (Array<Types::ServiceIntegrationsUnion>) —

    A collection of service integrations for the Redshift IAM Identity Center application.

Returns:

See Also:



2831
2832
2833
2834
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2831

def create_redshift_idc_application(params = {}, options = {})
  req = build_request(:create_redshift_idc_application, params)
  req.send_request(options)
end

#create_scheduled_action(params = {}) ⇒ 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,
      reserved_node_id: "String",
      target_reserved_node_offering_id: "String",
    },
    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 #=> Boolean
resp.target_action.resize_cluster.reserved_node_id #=> String
resp.target_action.resize_cluster.target_reserved_node_offering_id #=> String
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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:



2942
2943
2944
2945
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2942

def create_scheduled_action(params = {}, options = {})
  req = build_request(:create_scheduled_action, params)
  req.send_request(options)
end

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

Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_copy_grant_name (required, String) —

    The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services 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 Amazon Web Services account.

  • :kms_key_id (String) —

    The unique identifier of the encrypted symmetric key 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:



3013
3014
3015
3016
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3013

def create_snapshot_copy_grant(params = {}, options = {})
  req = build_request(:create_snapshot_copy_grant, params)
  req.send_request(options)
end

#create_snapshot_schedule(params = {}) ⇒ 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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



3086
3087
3088
3089
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3086

def create_snapshot_schedule(params = {}, options = {})
  req = build_request(:create_snapshot_schedule, params)
  req.send_request(options)
end

#create_tags(params = {}) ⇒ 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",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



3130
3131
3132
3133
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3130

def create_tags(params = {}, options = {})
  req = build_request(:create_tags, params)
  req.send_request(options)
end

#create_usage_limit(params = {}) ⇒ 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, cross-region-datasharing
  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", "cross-region-datasharing"
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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. If FeatureType is cross-region-datasharing, then LimitType must be data-scanned.

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



3215
3216
3217
3218
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3215

def create_usage_limit(params = {}, options = {})
  req = build_request(:create_usage_limit, params)
  req.send_request(options)
end

#deauthorize_data_share(params = {}) ⇒ Types::DataShare

From a datashare producer account, removes authorization from the specified datashare.

Examples:

Request syntax with placeholder values


resp = client.deauthorize_data_share({
  data_share_arn: "String", # required
  consumer_identifier: "String", # required
})

Response structure


resp.data_share_arn #=> String
resp.producer_arn #=> String
resp.allow_publicly_accessible_consumers #=> Boolean
resp.data_share_associations #=> Array
resp.data_share_associations[0].consumer_identifier #=> String
resp.data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_share_associations[0].consumer_region #=> String
resp.data_share_associations[0].created_date #=> Time
resp.data_share_associations[0].status_change_date #=> Time
resp.data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.managed_by #=> String
resp.data_share_type #=> String, one of "INTERNAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_share_arn (required, String) —

    The namespace Amazon Resource Name (ARN) of the datashare to remove authorization from.

  • :consumer_identifier (required, String) —

    The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.

Returns:

See Also:



3268
3269
3270
3271
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3268

def deauthorize_data_share(params = {}, options = {})
  req = build_request(:deauthorize_data_share, params)
  req.send_request(options)
end

#delete_authentication_profile(params = {}) ⇒ Types::DeleteAuthenticationProfileResult

Deletes an authentication profile.

Examples:

Request syntax with placeholder values


resp = client.delete_authentication_profile({
  authentication_profile_name: "AuthenticationProfileNameString", # required
})

Response structure


resp.authentication_profile_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authentication_profile_name (required, String) —

    The name of the authentication profile to delete.

Returns:

See Also:



3296
3297
3298
3299
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3296

def delete_authentication_profile(params = {}, options = {})
  req = build_request(:delete_authentication_profile, params)
  req.send_request(options)
end

#delete_cluster(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



3522
3523
3524
3525
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3522

def delete_cluster(params = {}, options = {})
  req = build_request(:delete_cluster, params)
  req.send_request(options)
end

#delete_cluster_parameter_group(params = {}) ⇒ 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
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



3555
3556
3557
3558
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3555

def delete_cluster_parameter_group(params = {}, options = {})
  req = build_request(:delete_cluster_parameter_group, params)
  req.send_request(options)
end

#delete_cluster_security_group(params = {}) ⇒ 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
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_security_group_name (required, String) —

    The name of the cluster security group to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3590
3591
3592
3593
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3590

def delete_cluster_security_group(params = {}, options = {})
  req = build_request(:delete_cluster_security_group, params)
  req.send_request(options)
end

#delete_cluster_snapshot(params = {}) ⇒ 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.engine_full_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 #=> Boolean
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshot.master_password_secret_arn #=> String
resp.snapshot.master_password_secret_kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



3680
3681
3682
3683
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3680

def delete_cluster_snapshot(params = {}, options = {})
  req = build_request(:delete_cluster_snapshot, params)
  req.send_request(options)
end

#delete_cluster_subnet_group(params = {}) ⇒ 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
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



3702
3703
3704
3705
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3702

def delete_cluster_subnet_group(params = {}, options = {})
  req = build_request(:delete_cluster_subnet_group, params)
  req.send_request(options)
end

#delete_custom_domain_association(params = {}) ⇒ Struct

Contains information about deleting a custom domain association for a cluster.

Examples:

Request syntax with placeholder values


resp = client.delete_custom_domain_association({
  cluster_identifier: "String", # required
  custom_domain_name: "CustomDomainNameString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The identifier of the cluster to delete a custom domain association for.

  • :custom_domain_name (required, String) —

    The custom domain name for the custom domain association.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3730
3731
3732
3733
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3730

def delete_custom_domain_association(params = {}, options = {})
  req = build_request(:delete_custom_domain_association, params)
  req.send_request(options)
end

#delete_endpoint_access(params = {}) ⇒ Types::EndpointAccess

Deletes a Redshift-managed VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_endpoint_access({
  endpoint_name: "String", # required
})

Response structure


resp.cluster_identifier #=> String
resp.resource_owner #=> String
resp.subnet_group_name #=> String
resp.endpoint_status #=> String
resp.endpoint_name #=> String
resp.endpoint_create_time #=> Time
resp.port #=> Integer
resp.address #=> String
resp.vpc_security_groups #=> Array
resp.vpc_security_groups[0].vpc_security_group_id #=> String
resp.vpc_security_groups[0].status #=> String
resp.vpc_endpoint.vpc_endpoint_id #=> String
resp.vpc_endpoint.vpc_id #=> String
resp.vpc_endpoint.network_interfaces #=> Array
resp.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.vpc_endpoint.network_interfaces[0].ipv_6_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoint_name (required, String) —

    The Redshift-managed VPC endpoint to delete.

Returns:

See Also:



3785
3786
3787
3788
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3785

def delete_endpoint_access(params = {}, options = {})
  req = build_request(:delete_endpoint_access, params)
  req.send_request(options)
end

#delete_event_subscription(params = {}) ⇒ Struct

Deletes an Amazon Redshift event notification subscription.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :subscription_name (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3808
3809
3810
3811
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3808

def delete_event_subscription(params = {}, options = {})
  req = build_request(:delete_event_subscription, params)
  req.send_request(options)
end

#delete_hsm_client_certificate(params = {}) ⇒ 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
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :hsm_client_certificate_identifier (required, String) —

    The identifier of the HSM client certificate to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3830
3831
3832
3833
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3830

def delete_hsm_client_certificate(params = {}, options = {})
  req = build_request(:delete_hsm_client_certificate, params)
  req.send_request(options)
end

#delete_hsm_configuration(params = {}) ⇒ Struct

Deletes the specified Amazon Redshift HSM configuration.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :hsm_configuration_identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3852
3853
3854
3855
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3852

def delete_hsm_configuration(params = {}, options = {})
  req = build_request(:delete_hsm_configuration, params)
  req.send_request(options)
end

#delete_integration(params = {}) ⇒ Types::Integration

Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.

Examples:

Request syntax with placeholder values


resp = client.delete_integration({
  integration_arn: "IntegrationArn", # required
})

Response structure


resp.integration_arn #=> String
resp.integration_name #=> String
resp.source_arn #=> String
resp.target_arn #=> String
resp.status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention"
resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.create_time #=> Time
resp.description #=> String
resp.kms_key_id #=> String
resp.additional_encryption_context #=> Hash
resp.additional_encryption_context["String"] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :integration_arn (required, String) —

    The unique identifier of the integration to delete.

Returns:

See Also:



3906
3907
3908
3909
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3906

def delete_integration(params = {}, options = {})
  req = build_request(:delete_integration, params)
  req.send_request(options)
end

#delete_partner(params = {}) ⇒ Types::PartnerIntegrationOutputMessage

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

Examples:

Request syntax with placeholder values


resp = client.delete_partner({
  account_id: "PartnerIntegrationAccountId", # required
  cluster_identifier: "PartnerIntegrationClusterIdentifier", # required
  database_name: "PartnerIntegrationDatabaseName", # required
  partner_name: "PartnerIntegrationPartnerName", # required
})

Response structure


resp.database_name #=> String
resp.partner_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the cluster.

  • :cluster_identifier (required, String) —

    The cluster identifier of the cluster that receives data from the partner.

  • :database_name (required, String) —

    The name of the database that receives data from the partner.

  • :partner_name (required, String) —

    The name of the partner that is authorized to send data.

Returns:

See Also:



3951
3952
3953
3954
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3951

def delete_partner(params = {}, options = {})
  req = build_request(:delete_partner, params)
  req.send_request(options)
end

#delete_redshift_idc_application(params = {}) ⇒ Struct

Deletes an Amazon Redshift IAM Identity Center application.

Examples:

Request syntax with placeholder values


resp = client.delete_redshift_idc_application({
  redshift_idc_application_arn: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :redshift_idc_application_arn (required, String) —

    The ARN for a deleted Amazon Redshift IAM Identity Center application.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3973
3974
3975
3976
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3973

def delete_redshift_idc_application(params = {}, options = {})
  req = build_request(:delete_redshift_idc_application, params)
  req.send_request(options)
end

#delete_resource_policy(params = {}) ⇒ Struct

Deletes the resource policy for a specified resource.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "String", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource of which its resource policy is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3996
3997
3998
3999
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3996

def delete_resource_policy(params = {}, options = {})
  req = build_request(:delete_resource_policy, params)
  req.send_request(options)
end

#delete_scheduled_action(params = {}) ⇒ Struct

Deletes a scheduled action.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :scheduled_action_name (required, String) —

    The name of the scheduled action to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4018
4019
4020
4021
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4018

def delete_scheduled_action(params = {}, options = {})
  req = build_request(:delete_scheduled_action, params)
  req.send_request(options)
end

#delete_snapshot_copy_grant(params = {}) ⇒ 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
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_copy_grant_name (required, String) —

    The name of the snapshot copy grant to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4040
4041
4042
4043
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4040

def delete_snapshot_copy_grant(params = {}, options = {})
  req = build_request(:delete_snapshot_copy_grant, params)
  req.send_request(options)
end

#delete_snapshot_schedule(params = {}) ⇒ Struct

Deletes a snapshot schedule.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :schedule_identifier (required, String) —

    A unique identifier of the snapshot schedule to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4062
4063
4064
4065
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4062

def delete_snapshot_schedule(params = {}, options = {})
  req = build_request(:delete_snapshot_schedule, params)
  req.send_request(options)
end

#delete_tags(params = {}) ⇒ 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
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



4091
4092
4093
4094
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4091

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end

#delete_usage_limit(params = {}) ⇒ Struct

Deletes a usage limit from a cluster.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :usage_limit_id (required, String) —

    The identifier of the usage limit to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4113
4114
4115
4116
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4113

def delete_usage_limit(params = {}, options = {})
  req = build_request(:delete_usage_limit, params)
  req.send_request(options)
end

#deregister_namespace(params = {}) ⇒ Types::DeregisterNamespaceOutputMessage

Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog.

Examples:

Request syntax with placeholder values


resp = client.deregister_namespace({
  namespace_identifier: { # required
    serverless_identifier: {
      namespace_identifier: "String", # required
      workgroup_identifier: "String", # required
    },
    provisioned_identifier: {
      cluster_identifier: "String", # required
    },
  },
  consumer_identifiers: ["String"], # required
})

Response structure


resp.status #=> String, one of "Registering", "Deregistering"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :namespace_identifier (required, Types::NamespaceIdentifierUnion) —

    The unique identifier of the cluster or serverless namespace that you want to deregister.

  • :consumer_identifiers (required, Array<String>) —

    An array containing the ID of the consumer account that you want to deregister the cluster or serverless namespace from.

Returns:

See Also:



4156
4157
4158
4159
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4156

def deregister_namespace(params = {}, options = {})
  req = build_request(:deregister_namespace, params)
  req.send_request(options)
end

#describe_account_attributes(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :attribute_names (Array<String>) —

    A list of attribute names.

Returns:

See Also:



4187
4188
4189
4190
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4187

def (params = {}, options = {})
  req = build_request(:describe_account_attributes, params)
  req.send_request(options)
end

#describe_authentication_profiles(params = {}) ⇒ Types::DescribeAuthenticationProfilesResult

Describes an authentication profile.

Examples:

Request syntax with placeholder values


resp = client.describe_authentication_profiles({
  authentication_profile_name: "AuthenticationProfileNameString",
})

Response structure


resp.authentication_profiles #=> Array
resp.authentication_profiles[0].authentication_profile_name #=> String
resp.authentication_profiles[0].authentication_profile_content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authentication_profile_name (String) —

    The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.

Returns:

See Also:



4218
4219
4220
4221
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4218

def describe_authentication_profiles(params = {}, options = {})
  req = build_request(:describe_authentication_profiles, params)
  req.send_request(options)
end

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

Returns an array of ClusterDbRevision objects.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



4285
4286
4287
4288
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4285

def describe_cluster_db_revisions(params = {}, options = {})
  req = build_request(:describe_cluster_db_revisions, params)
  req.send_request(options)
end

#describe_cluster_parameter_groups(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



4391
4392
4393
4394
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4391

def describe_cluster_parameter_groups(params = {}, options = {})
  req = build_request(:describe_cluster_parameter_groups, params)
  req.send_request(options)
end

#describe_cluster_parameters(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
resp.parameters[0].minimum_engine_version #=> String
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



4480
4481
4482
4483
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4480

def describe_cluster_parameters(params = {}, options = {})
  req = build_request(:describe_cluster_parameters, params)
  req.send_request(options)
end

#describe_cluster_security_groups(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_security_group_name (String) —

    The name of a cluster security group for which you are requesting details. You must 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, Amazon Web Services 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 must 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:



4600
4601
4602
4603
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4600

def describe_cluster_security_groups(params = {}, options = {})
  req = build_request(:describe_cluster_security_groups, params)
  req.send_request(options)
end

#describe_cluster_snapshots(params = {}) ⇒ 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 your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • snapshot_available

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_snapshots({
  cluster_identifier: "String",
  snapshot_identifier: "String",
  snapshot_arn: "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].engine_full_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 #=> Boolean
resp.snapshots[0].kms_key_id #=> String
resp.snapshots[0].encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshots[0].master_password_secret_arn #=> String
resp.snapshots[0].master_password_secret_kms_key_id #=> String
resp.snapshots[0].snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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_arn (String) —

    The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

  • :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, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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, Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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:



4815
4816
4817
4818
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4815

def describe_cluster_snapshots(params = {}, options = {})
  req = build_request(:describe_cluster_snapshots, params)
  req.send_request(options)
end

#describe_cluster_subnet_groups(params = {}) ⇒ 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 your Amazon Web Services 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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
resp.cluster_subnet_groups[0].supported_cluster_ip_address_types #=> Array
resp.cluster_subnet_groups[0].supported_cluster_ip_address_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



4918
4919
4920
4921
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4918

def describe_cluster_subnet_groups(params = {}, options = {})
  req = build_request(:describe_cluster_subnet_groups, params)
  req.send_request(options)
end

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

Returns a list of all the available maintenance tracks.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



4971
4972
4973
4974
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4971

def describe_cluster_tracks(params = {}, options = {})
  req = build_request(:describe_cluster_tracks, params)
  req.send_request(options)
end

#describe_cluster_versions(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



5051
5052
5053
5054
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5051

def describe_cluster_versions(params = {}, options = {})
  req = build_request(:describe_cluster_versions, params)
  req.send_request(options)
end

#describe_clusters(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • cluster_available
  • cluster_deleted
  • cluster_restored

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].endpoint.vpc_endpoints #=> Array
resp.clusters[0].endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.clusters[0].endpoint.vpc_endpoints[0].vpc_id #=> String
resp.clusters[0].endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.clusters[0].endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.clusters[0].endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.clusters[0].endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.clusters[0].endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.clusters[0].endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.clusters[0].pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.clusters[0].number_of_nodes #=> Integer
resp.clusters[0].publicly_accessible #=> Boolean
resp.clusters[0].encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.clusters[0].availability_zone_relocation_status #=> String
resp.clusters[0].cluster_namespace_arn #=> String
resp.clusters[0].total_storage_capacity_in_mega_bytes #=> Integer
resp.clusters[0].aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.clusters[0].aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.clusters[0].default_iam_role_arn #=> String
resp.clusters[0].reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.clusters[0].reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.clusters[0].reserved_node_exchange_status.request_time #=> Time
resp.clusters[0].reserved_node_exchange_status.source_reserved_node_id #=> String
resp.clusters[0].reserved_node_exchange_status.source_reserved_node_type #=> String
resp.clusters[0].reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.clusters[0].reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.clusters[0].reserved_node_exchange_status.target_reserved_node_type #=> String
resp.clusters[0].reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.clusters[0].custom_domain_name #=> String
resp.clusters[0].custom_domain_certificate_arn #=> String
resp.clusters[0].custom_domain_certificate_expiry_date #=> Time
resp.clusters[0].master_password_secret_arn #=> String
resp.clusters[0].master_password_secret_kms_key_id #=> String
resp.clusters[0].ip_address_type #=> String
resp.clusters[0].multi_az #=> String
resp.clusters[0].multi_az_secondary.availability_zone #=> String
resp.clusters[0].multi_az_secondary.cluster_nodes #=> Array
resp.clusters[0].multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.clusters[0].multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.clusters[0].multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



5287
5288
5289
5290
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5287

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, params)
  req.send_request(options)
end

#describe_custom_domain_associations(params = {}) ⇒ Types::CustomDomainAssociationsMessage

Contains information about custom domain associations for a cluster.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_custom_domain_associations({
  custom_domain_name: "CustomDomainNameString",
  custom_domain_certificate_arn: "CustomDomainCertificateArnString",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.associations #=> Array
resp.associations[0].custom_domain_certificate_arn #=> String
resp.associations[0].custom_domain_certificate_expiry_date #=> Time
resp.associations[0].certificate_associations #=> Array
resp.associations[0].certificate_associations[0].custom_domain_name #=> String
resp.associations[0].certificate_associations[0].cluster_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_domain_name (String) —

    The custom domain name for the custom domain association.

  • :custom_domain_certificate_arn (String) —

    The certificate Amazon Resource Name (ARN) for the custom domain association.

  • :max_records (Integer) —

    The maximum records setting for the associated custom domain.

  • :marker (String) —

    The marker for the custom domain association.

Returns:

See Also:



5337
5338
5339
5340
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5337

def describe_custom_domain_associations(params = {}, options = {})
  req = build_request(:describe_custom_domain_associations, params)
  req.send_request(options)
end

#describe_data_shares(params = {}) ⇒ Types::DescribeDataSharesResult

Shows the status of any inbound or outbound datashares available in the specified account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_data_shares({
  data_share_arn: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.data_shares #=> Array
resp.data_shares[0].data_share_arn #=> String
resp.data_shares[0].producer_arn #=> String
resp.data_shares[0].allow_publicly_accessible_consumers #=> Boolean
resp.data_shares[0].data_share_associations #=> Array
resp.data_shares[0].data_share_associations[0].consumer_identifier #=> String
resp.data_shares[0].data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_shares[0].data_share_associations[0].consumer_region #=> String
resp.data_shares[0].data_share_associations[0].created_date #=> Time
resp.data_shares[0].data_share_associations[0].status_change_date #=> Time
resp.data_shares[0].data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_shares[0].data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.data_shares[0].managed_by #=> String
resp.data_shares[0].data_share_type #=> String, one of "INTERNAL"
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_share_arn (String) —

    The Amazon resource name (ARN) of the datashare to describe details of.

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

  • :marker (String) —

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services 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:



5402
5403
5404
5405
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5402

def describe_data_shares(params = {}, options = {})
  req = build_request(:describe_data_shares, params)
  req.send_request(options)
end

#describe_data_shares_for_consumer(params = {}) ⇒ Types::DescribeDataSharesForConsumerResult

Returns a list of datashares where the account identifier being called is a consumer account identifier.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_data_shares_for_consumer({
  consumer_arn: "String",
  status: "ACTIVE", # accepts ACTIVE, AVAILABLE
  max_records: 1,
  marker: "String",
})

Response structure


resp.data_shares #=> Array
resp.data_shares[0].data_share_arn #=> String
resp.data_shares[0].producer_arn #=> String
resp.data_shares[0].allow_publicly_accessible_consumers #=> Boolean
resp.data_shares[0].data_share_associations #=> Array
resp.data_shares[0].data_share_associations[0].consumer_identifier #=> String
resp.data_shares[0].data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_shares[0].data_share_associations[0].consumer_region #=> String
resp.data_shares[0].data_share_associations[0].created_date #=> Time
resp.data_shares[0].data_share_associations[0].status_change_date #=> Time
resp.data_shares[0].data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_shares[0].data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.data_shares[0].managed_by #=> String
resp.data_shares[0].data_share_type #=> String, one of "INTERNAL"
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :consumer_arn (String) —

    The Amazon Resource Name (ARN) of the consumer namespace that returns in the list of datashares.

  • :status (String) —

    An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

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

  • :marker (String) —

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer request exceed the value specified in MaxRecords, Amazon Web Services 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:



5473
5474
5475
5476
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5473

def describe_data_shares_for_consumer(params = {}, options = {})
  req = build_request(:describe_data_shares_for_consumer, params)
  req.send_request(options)
end

#describe_data_shares_for_producer(params = {}) ⇒ Types::DescribeDataSharesForProducerResult

Returns a list of datashares when the account identifier being called is a producer account identifier.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_data_shares_for_producer({
  producer_arn: "String",
  status: "ACTIVE", # accepts ACTIVE, AUTHORIZED, PENDING_AUTHORIZATION, DEAUTHORIZED, REJECTED
  max_records: 1,
  marker: "String",
})

Response structure


resp.data_shares #=> Array
resp.data_shares[0].data_share_arn #=> String
resp.data_shares[0].producer_arn #=> String
resp.data_shares[0].allow_publicly_accessible_consumers #=> Boolean
resp.data_shares[0].data_share_associations #=> Array
resp.data_shares[0].data_share_associations[0].consumer_identifier #=> String
resp.data_shares[0].data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_shares[0].data_share_associations[0].consumer_region #=> String
resp.data_shares[0].data_share_associations[0].created_date #=> Time
resp.data_shares[0].data_share_associations[0].status_change_date #=> Time
resp.data_shares[0].data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_shares[0].data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.data_shares[0].managed_by #=> String
resp.data_shares[0].data_share_type #=> String, one of "INTERNAL"
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :producer_arn (String) —

    The Amazon Resource Name (ARN) of the producer namespace that returns in the list of datashares.

  • :status (String) —

    An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

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

  • :marker (String) —

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer request exceed the value specified in MaxRecords, Amazon Web Services 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:



5544
5545
5546
5547
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5544

def describe_data_shares_for_producer(params = {}, options = {})
  req = build_request(:describe_data_shares_for_producer, params)
  req.send_request(options)
end

#describe_default_cluster_parameters(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
resp.default_cluster_parameters.parameters[0].minimum_engine_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



5616
5617
5618
5619
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5616

def describe_default_cluster_parameters(params = {}, options = {})
  req = build_request(:describe_default_cluster_parameters, params)
  req.send_request(options)
end

#describe_endpoint_access(params = {}) ⇒ Types::EndpointAccessList

Describes a Redshift-managed VPC endpoint.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint_access({
  cluster_identifier: "String",
  resource_owner: "String",
  endpoint_name: "String",
  vpc_id: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.endpoint_access_list #=> Array
resp.endpoint_access_list[0].cluster_identifier #=> String
resp.endpoint_access_list[0].resource_owner #=> String
resp.endpoint_access_list[0].subnet_group_name #=> String
resp.endpoint_access_list[0].endpoint_status #=> String
resp.endpoint_access_list[0].endpoint_name #=> String
resp.endpoint_access_list[0].endpoint_create_time #=> Time
resp.endpoint_access_list[0].port #=> Integer
resp.endpoint_access_list[0].address #=> String
resp.endpoint_access_list[0].vpc_security_groups #=> Array
resp.endpoint_access_list[0].vpc_security_groups[0].vpc_security_group_id #=> String
resp.endpoint_access_list[0].vpc_security_groups[0].status #=> String
resp.endpoint_access_list[0].vpc_endpoint.vpc_endpoint_id #=> String
resp.endpoint_access_list[0].vpc_endpoint.vpc_id #=> String
resp.endpoint_access_list[0].vpc_endpoint.network_interfaces #=> Array
resp.endpoint_access_list[0].vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.endpoint_access_list[0].vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.endpoint_access_list[0].vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.endpoint_access_list[0].vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.endpoint_access_list[0].vpc_endpoint.network_interfaces[0].ipv_6_address #=> String
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier associated with the described endpoint.

  • :resource_owner (String) —

    The Amazon Web Services account ID of the owner of the cluster.

  • :endpoint_name (String) —

    The name of the endpoint to be described.

  • :vpc_id (String) —

    The virtual private cloud (VPC) identifier with access to the cluster.

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



5693
5694
5695
5696
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5693

def describe_endpoint_access(params = {}, options = {})
  req = build_request(:describe_endpoint_access, params)
  req.send_request(options)
end

#describe_endpoint_authorization(params = {}) ⇒ Types::EndpointAuthorizationList

Describes an endpoint authorization.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_endpoint_authorization({
  cluster_identifier: "String",
  account: "String",
  grantee: false,
  max_records: 1,
  marker: "String",
})

Response structure


resp.endpoint_authorization_list #=> Array
resp.endpoint_authorization_list[0].grantor #=> String
resp.endpoint_authorization_list[0].grantee #=> String
resp.endpoint_authorization_list[0].cluster_identifier #=> String
resp.endpoint_authorization_list[0].authorize_time #=> Time
resp.endpoint_authorization_list[0].cluster_status #=> String
resp.endpoint_authorization_list[0].status #=> String, one of "Authorized", "Revoking"
resp.endpoint_authorization_list[0].allowed_all_vp_cs #=> Boolean
resp.endpoint_authorization_list[0].allowed_vp_cs #=> Array
resp.endpoint_authorization_list[0].allowed_vp_cs[0] #=> String
resp.endpoint_authorization_list[0].endpoint_count #=> Integer
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster identifier of the cluster to access.

  • :account (String) —

    The Amazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.

  • :grantee (Boolean) —

    Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.

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



5762
5763
5764
5765
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5762

def describe_endpoint_authorization(params = {}, options = {})
  req = build_request(:describe_endpoint_authorization, params)
  req.send_request(options)
end

#describe_event_categories(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



5807
5808
5809
5810
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5807

def describe_event_categories(params = {}, options = {})
  req = build_request(:describe_event_categories, params)
  req.send_request(options)
end

#describe_event_subscriptions(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



5910
5911
5912
5913
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5910

def describe_event_subscriptions(params = {}, options = {})
  req = build_request(:describe_event_subscriptions, params)
  req.send_request(options)
end

#describe_events(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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, Amazon Web Services 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:



6045
6046
6047
6048
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6045

def describe_events(params = {}, options = {})
  req = build_request(:describe_events, params)
  req.send_request(options)
end

#describe_hsm_client_certificates(params = {}) ⇒ 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 Amazon Web Services 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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, Amazon Web Services 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:



6140
6141
6142
6143
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6140

def describe_hsm_client_certificates(params = {}, options = {})
  req = build_request(:describe_hsm_client_certificates, params)
  req.send_request(options)
end

#describe_hsm_configurations(params = {}) ⇒ 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 Amazon Web Services 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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, Amazon Web Services 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:



6237
6238
6239
6240
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6237

def describe_hsm_configurations(params = {}, options = {})
  req = build_request(:describe_hsm_configurations, params)
  req.send_request(options)
end

#describe_inbound_integrations(params = {}) ⇒ Types::InboundIntegrationsMessage

Returns a list of inbound integrations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_inbound_integrations({
  integration_arn: "InboundIntegrationArn",
  target_arn: "TargetArn",
  max_records: 1,
  marker: "String",
})

Response structure


resp.marker #=> String
resp.inbound_integrations #=> Array
resp.inbound_integrations[0].integration_arn #=> String
resp.inbound_integrations[0].source_arn #=> String
resp.inbound_integrations[0].target_arn #=> String
resp.inbound_integrations[0].status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention"
resp.inbound_integrations[0].errors #=> Array
resp.inbound_integrations[0].errors[0].error_code #=> String
resp.inbound_integrations[0].errors[0].error_message #=> String
resp.inbound_integrations[0].create_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :integration_arn (String) —

    The Amazon Resource Name (ARN) of the inbound integration.

  • :target_arn (String) —

    The Amazon Resource Name (ARN) of the target of an inbound integration.

  • :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 DescribeInboundIntegrations request exceed the value specified in MaxRecords, Amazon Web Services 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:



6304
6305
6306
6307
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6304

def describe_inbound_integrations(params = {}, options = {})
  req = build_request(:describe_inbound_integrations, params)
  req.send_request(options)
end

#describe_integrations(params = {}) ⇒ Types::IntegrationsMessage

Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_integrations({
  integration_arn: "IntegrationArn",
  max_records: 1,
  marker: "String",
  filters: [
    {
      name: "integration-arn", # required, accepts integration-arn, source-arn, source-types, status
      values: ["String"], # required
    },
  ],
})

Response structure


resp.marker #=> String
resp.integrations #=> Array
resp.integrations[0].integration_arn #=> String
resp.integrations[0].integration_name #=> String
resp.integrations[0].source_arn #=> String
resp.integrations[0].target_arn #=> String
resp.integrations[0].status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention"
resp.integrations[0].errors #=> Array
resp.integrations[0].errors[0].error_code #=> String
resp.integrations[0].errors[0].error_message #=> String
resp.integrations[0].create_time #=> Time
resp.integrations[0].description #=> String
resp.integrations[0].kms_key_id #=> String
resp.integrations[0].additional_encryption_context #=> Hash
resp.integrations[0].additional_encryption_context["String"] #=> String
resp.integrations[0].tags #=> Array
resp.integrations[0].tags[0].key #=> String
resp.integrations[0].tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :integration_arn (String) —

    The unique identifier of the integration.

  • :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 pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • :filters (Array<Types::DescribeIntegrationsFilter>) —

    A filter that specifies one or more resources to return.

Returns:

See Also:



6381
6382
6383
6384
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6381

def describe_integrations(params = {}, options = {})
  req = build_request(:describe_integrations, params)
  req.send_request(options)
end

#describe_logging_status(params = {}) ⇒ 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 #=> Boolean
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
resp.log_destination_type #=> String, one of "s3", "cloudwatch"
resp.log_exports #=> Array
resp.log_exports[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

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

    Example: examplecluster

Returns:

See Also:



6427
6428
6429
6430
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6427

def describe_logging_status(params = {}, options = {})
  req = build_request(:describe_logging_status, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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",
  snapshot_arn: "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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

  • :snapshot_arn (String) —

    The Amazon Resource Name (ARN) of the snapshot associated with the message to describe node configuration.

  • :owner_account (String) —

    The Amazon Web Services 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, Amazon Web Services 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:



6522
6523
6524
6525
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6522

def describe_node_configuration_options(params = {}, options = {})
  req = build_request(:describe_node_configuration_options, params)
  req.send_request(options)
end

#describe_orderable_cluster_options(params = {}) ⇒ 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 Amazon Web Services 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



6607
6608
6609
6610
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6607

def describe_orderable_cluster_options(params = {}, options = {})
  req = build_request(:describe_orderable_cluster_options, params)
  req.send_request(options)
end

#describe_partners(params = {}) ⇒ Types::DescribePartnersOutputMessage

Returns information about the partner integrations defined for a cluster.

Examples:

Request syntax with placeholder values


resp = client.describe_partners({
  account_id: "PartnerIntegrationAccountId", # required
  cluster_identifier: "PartnerIntegrationClusterIdentifier", # required
  database_name: "PartnerIntegrationDatabaseName",
  partner_name: "PartnerIntegrationPartnerName",
})

Response structure


resp.partner_integration_info_list #=> Array
resp.partner_integration_info_list[0].database_name #=> String
resp.partner_integration_info_list[0].partner_name #=> String
resp.partner_integration_info_list[0].status #=> String, one of "Active", "Inactive", "RuntimeFailure", "ConnectionFailure"
resp.partner_integration_info_list[0].status_message #=> String
resp.partner_integration_info_list[0].created_at #=> Time
resp.partner_integration_info_list[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the cluster.

  • :cluster_identifier (required, String) —

    The cluster identifier of the cluster whose partner integration is being described.

  • :database_name (String) —

    The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.

  • :partner_name (String) —

    The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

Returns:

See Also:



6658
6659
6660
6661
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6658

def describe_partners(params = {}, options = {})
  req = build_request(:describe_partners, params)
  req.send_request(options)
end

#describe_redshift_idc_applications(params = {}) ⇒ Types::DescribeRedshiftIdcApplicationsResult

Lists the Amazon Redshift IAM Identity Center applications.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_redshift_idc_applications({
  redshift_idc_application_arn: "String",
  max_records: 1,
  marker: "String",
})

Response structure


resp.redshift_idc_applications #=> Array
resp.redshift_idc_applications[0].idc_instance_arn #=> String
resp.redshift_idc_applications[0].redshift_idc_application_name #=> String
resp.redshift_idc_applications[0].redshift_idc_application_arn #=> String
resp.redshift_idc_applications[0].identity_namespace #=> String
resp.redshift_idc_applications[0].idc_display_name #=> String
resp.redshift_idc_applications[0].iam_role_arn #=> String
resp.redshift_idc_applications[0].idc_managed_application_arn #=> String
resp.redshift_idc_applications[0].idc_onboard_status #=> String
resp.redshift_idc_applications[0].authorized_token_issuer_list #=> Array
resp.redshift_idc_applications[0].authorized_token_issuer_list[0].trusted_token_issuer_arn #=> String
resp.redshift_idc_applications[0].authorized_token_issuer_list[0].authorized_audiences_list #=> Array
resp.redshift_idc_applications[0].authorized_token_issuer_list[0].authorized_audiences_list[0] #=> String
resp.redshift_idc_applications[0].service_integrations #=> Array
resp.redshift_idc_applications[0].service_integrations[0].lake_formation #=> Array
resp.redshift_idc_applications[0].service_integrations[0].lake_formation[0].lake_formation_query.authorization #=> String, one of "Enabled", "Disabled"
resp.redshift_idc_applications[0].service_integrations[0].s3_access_grants #=> Array
resp.redshift_idc_applications[0].service_integrations[0].s3_access_grants[0].read_write_access.authorization #=> String, one of "Enabled", "Disabled"
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :redshift_idc_application_arn (String) —

    The ARN for the Redshift application that integrates with IAM Identity Center.

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

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

Returns:

See Also:



6725
6726
6727
6728
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6725

def describe_redshift_idc_applications(params = {}, options = {})
  req = build_request(:describe_redshift_idc_applications, params)
  req.send_request(options)
end

#describe_reserved_node_exchange_status(params = {}) ⇒ Types::DescribeReservedNodeExchangeStatusOutputMessage

Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.reserved_node_exchange_status_details #=> Array
resp.reserved_node_exchange_status_details[0].reserved_node_exchange_request_id #=> String
resp.reserved_node_exchange_status_details[0].status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.reserved_node_exchange_status_details[0].request_time #=> Time
resp.reserved_node_exchange_status_details[0].source_reserved_node_id #=> String
resp.reserved_node_exchange_status_details[0].source_reserved_node_type #=> String
resp.reserved_node_exchange_status_details[0].source_reserved_node_count #=> Integer
resp.reserved_node_exchange_status_details[0].target_reserved_node_offering_id #=> String
resp.reserved_node_exchange_status_details[0].target_reserved_node_type #=> String
resp.reserved_node_exchange_status_details[0].target_reserved_node_count #=> Integer
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_node_id (String) —

    The identifier of the source reserved node in a reserved-node exchange request.

  • :reserved_node_exchange_request_id (String) —

    The identifier of the reserved-node exchange 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.

  • :marker (String) —

    An optional pagination token provided by a previous DescribeReservedNodeExchangeStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. 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:



6790
6791
6792
6793
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6790

def describe_reserved_node_exchange_status(params = {}, options = {})
  req = build_request(:describe_reserved_node_exchange_status, params)
  req.send_request(options)
end

#describe_reserved_node_offerings(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



6868
6869
6870
6871
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6868

def describe_reserved_node_offerings(params = {}, options = {})
  req = build_request(:describe_reserved_node_offerings, params)
  req.send_request(options)
end

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

Returns the descriptions of the reserved nodes.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



6937
6938
6939
6940
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 6937

def describe_reserved_nodes(params = {}, options = {})
  req = build_request(:describe_reserved_nodes, params)
  req.send_request(options)
end

#describe_resize(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services account are returned.

Returns:

See Also:



7009
7010
7011
7012
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7009

def describe_resize(params = {}, options = {})
  req = build_request(:describe_resize, params)
  req.send_request(options)
end

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

Describes properties of scheduled actions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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 #=> Boolean
resp.scheduled_actions[0].target_action.resize_cluster.reserved_node_id #=> String
resp.scheduled_actions[0].target_action.resize_cluster.target_reserved_node_offering_id #=> String
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

    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, DateTime, Date, Integer, String) —

    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, Amazon Web Services 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:



7111
7112
7113
7114
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7111

def describe_scheduled_actions(params = {}, options = {})
  req = build_request(:describe_scheduled_actions, params)
  req.send_request(options)
end

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

Returns a list of snapshot copy grants owned by the Amazon Web Services 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



7200
7201
7202
7203
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7200

def describe_snapshot_copy_grants(params = {}, options = {})
  req = build_request(:describe_snapshot_copy_grants, params)
  req.send_request(options)
end

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

Returns a list of snapshot schedules.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



7275
7276
7277
7278
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7275

def describe_snapshot_schedules(params = {}, options = {})
  req = build_request(:describe_snapshot_schedules, params)
  req.send_request(options)
end

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

Returns account level backups storage size and provisional storage.

Examples:

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



7296
7297
7298
7299
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7296

def describe_storage(params = {}, options = {})
  req = build_request(:describe_storage, params)
  req.send_request(options)
end

#describe_table_restore_status(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



7369
7370
7371
7372
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7369

def describe_table_restore_status(params = {}, options = {})
  req = build_request(:describe_table_restore_status, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

    • Integration (zero-ETL integration or S3 event integration)

      To describe the tags associated with an integration, don't specify ResourceType, instead specify the ResourceName of the integration.

    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:



7507
7508
7509
7510
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7507

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#describe_usage_limits(params = {}) ⇒ 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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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, cross-region-datasharing
  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", "cross-region-datasharing"
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, Amazon Web Services 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:



7616
7617
7618
7619
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7616

def describe_usage_limits(params = {}, options = {})
  req = build_request(:describe_usage_limits, params)
  req.send_request(options)
end

#disable_logging(params = {}) ⇒ 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 #=> Boolean
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
resp.log_destination_type #=> String, one of "s3", "cloudwatch"
resp.log_exports #=> Array
resp.log_exports[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

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

    Example: examplecluster

Returns:

See Also:



7662
7663
7664
7665
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7662

def disable_logging(params = {}, options = {})
  req = build_request(:disable_logging, params)
  req.send_request(options)
end

#disable_snapshot_copy(params = {}) ⇒ 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 an encrypted symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the key 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



7830
7831
7832
7833
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7830

def disable_snapshot_copy(params = {}, options = {})
  req = build_request(:disable_snapshot_copy, params)
  req.send_request(options)
end

#disassociate_data_share_consumer(params = {}) ⇒ Types::DataShare

From a datashare consumer account, remove association for the specified datashare.

Examples:

Request syntax with placeholder values


resp = client.disassociate_data_share_consumer({
  data_share_arn: "String", # required
  disassociate_entire_account: false,
  consumer_arn: "String",
  consumer_region: "String",
})

Response structure


resp.data_share_arn #=> String
resp.producer_arn #=> String
resp.allow_publicly_accessible_consumers #=> Boolean
resp.data_share_associations #=> Array
resp.data_share_associations[0].consumer_identifier #=> String
resp.data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_share_associations[0].consumer_region #=> String
resp.data_share_associations[0].created_date #=> Time
resp.data_share_associations[0].status_change_date #=> Time
resp.data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.managed_by #=> String
resp.data_share_type #=> String, one of "INTERNAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_share_arn (required, String) —

    The Amazon Resource Name (ARN) of the datashare to remove association for.

  • :disassociate_entire_account (Boolean) —

    A value that specifies whether association for the datashare is removed from the entire account.

  • :consumer_arn (String) —

    The Amazon Resource Name (ARN) of the consumer namespace that association for the datashare is removed from.

  • :consumer_region (String) —

    From a datashare consumer account, removes association of a datashare from all the existing and future namespaces in the specified Amazon Web Services Region.

Returns:

See Also:



7893
7894
7895
7896
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7893

def disassociate_data_share_consumer(params = {}, options = {})
  req = build_request(:disassociate_data_share_consumer, params)
  req.send_request(options)
end

#enable_logging(params = {}) ⇒ 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",
  s3_key_prefix: "S3KeyPrefixValue",
  log_destination_type: "s3", # accepts s3, cloudwatch
  log_exports: ["String"],
})

Response structure


resp.logging_enabled #=> Boolean
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
resp.log_destination_type #=> String, one of "s3", "cloudwatch"
resp.log_exports #=> Array
resp.log_exports[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

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

    Example: examplecluster

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

    Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (`), hyphen (-), at symbol (@`).

  • :log_destination_type (String) —

    The log destination type. An enum with possible values of s3 and cloudwatch.

  • :log_exports (Array<String>) —

    The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

Returns:

See Also:



7969
7970
7971
7972
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 7969

def enable_logging(params = {}, options = {})
  req = build_request(:enable_logging, params)
  req.send_request(options)
end

#enable_snapshot_copy(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services Region that you want to copy snapshots to.

    Constraints: Must be the name of a valid Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region after they are copied from the source Amazon Web Services 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:



8168
8169
8170
8171
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8168

def enable_snapshot_copy(params = {}, options = {})
  req = build_request(:enable_snapshot_copy, params)
  req.send_request(options)
end

#failover_primary_compute(params = {}) ⇒ Types::FailoverPrimaryComputeResult

Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone.

Examples:

Request syntax with placeholder values


resp = client.failover_primary_compute({
  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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The unique identifier of the cluster for which the primary compute unit will be failed over to another Availability Zone.

Returns:

See Also:



8328
8329
8330
8331
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8328

def failover_primary_compute(params = {}, options = {})
  req = build_request(:failover_primary_compute, params)
  req.send_request(options)
end

#get_cluster_credentials(params = {}) ⇒ 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 Identity and Access Management (IAM) user or role that runs 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 permission.

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",
  duration_seconds: 1,
  auto_create: false,
  db_groups: ["String"],
  custom_domain_name: "String",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 uppercase or 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 uppercase or 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 (String) —

    The unique identifier of the cluster that contains the database for which you 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.

  • :custom_domain_name (String) —

    The custom domain name for the cluster credentials.

Returns:

See Also:



8492
8493
8494
8495
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8492

def get_cluster_credentials(params = {}, options = {})
  req = build_request(:get_cluster_credentials, params)
  req.send_request(options)
end

#get_cluster_credentials_with_iam(params = {}) ⇒ Types::ClusterExtendedCredentials

Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to the source Identity and Access Management (IAM) identity. For more information about IAM identities, see IAM Identities (users, user groups, and roles) in the Amazon Web Services Identity and Access Management User Guide.

The Identity and Access Management (IAM) identity that runs this operation must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Using identity-based policies (IAM policies) in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.get_cluster_credentials_with_iam({
  db_name: "String",
  cluster_identifier: "String",
  duration_seconds: 1,
  custom_domain_name: "String",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :db_name (String) —

    The name of the database for which you are requesting credentials. If the database name is specified, the IAM policy must allow access to the resource dbname for the specified database name. If the database name is not specified, access to all databases is allowed.

  • :cluster_identifier (String) —

    The unique identifier of the cluster that contains the database for which you are requesting credentials.

  • :duration_seconds (Integer) —

    The number of seconds until the returned temporary password expires.

    Range: 900-3600. Default: 900.

  • :custom_domain_name (String) —

    The custom domain name for the IAM message cluster credentials.

Returns:

See Also:



8560
8561
8562
8563
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8560

def get_cluster_credentials_with_iam(params = {}, options = {})
  req = build_request(:get_cluster_credentials_with_iam, params)
  req.send_request(options)
end

#get_reserved_node_exchange_configuration_options(params = {}) ⇒ Types::GetReservedNodeExchangeConfigurationOptionsOutputMessage

Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_reserved_node_exchange_configuration_options({
  action_type: "restore-cluster", # required, accepts restore-cluster, resize-cluster
  cluster_identifier: "String",
  snapshot_identifier: "String",
  max_records: 1,
  marker: "String",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_type (required, String) —

    The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.

  • :cluster_identifier (String) —

    The identifier for the cluster that is the source for a reserved-node exchange.

  • :snapshot_identifier (String) —

    The identifier for the snapshot that is the source for the reserved-node exchange.

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

  • :marker (String) —

    An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. 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:



8651
8652
8653
8654
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8651

def get_reserved_node_exchange_configuration_options(params = {}, options = {})
  req = build_request(:get_reserved_node_exchange_configuration_options, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



8706
8707
8708
8709
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8706

def get_reserved_node_exchange_offerings(params = {}, options = {})
  req = build_request(:get_reserved_node_exchange_offerings, params)
  req.send_request(options)
end

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResult

Get the resource policy for a specified resource.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "String", # required
})

Response structure


resp.resource_policy.resource_arn #=> String
resp.resource_policy.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource of which its resource policy is fetched.

Returns:

See Also:



8736
8737
8738
8739
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8736

def get_resource_policy(params = {}, options = {})
  req = build_request(:get_resource_policy, params)
  req.send_request(options)
end

#list_recommendations(params = {}) ⇒ Types::ListRecommendationsResult

List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


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

Response structure


resp.recommendations #=> Array
resp.recommendations[0].id #=> String
resp.recommendations[0].cluster_identifier #=> String
resp.recommendations[0].namespace_arn #=> String
resp.recommendations[0].created_at #=> Time
resp.recommendations[0].recommendation_type #=> String
resp.recommendations[0].title #=> String
resp.recommendations[0].description #=> String
resp.recommendations[0].observation #=> String
resp.recommendations[0].impact_ranking #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].recommendation_text #=> String
resp.recommendations[0].recommended_actions #=> Array
resp.recommendations[0].recommended_actions[0].text #=> String
resp.recommendations[0].recommended_actions[0].database #=> String
resp.recommendations[0].recommended_actions[0].command #=> String
resp.recommendations[0].recommended_actions[0].type #=> String, one of "SQL", "CLI"
resp.recommendations[0].reference_links #=> Array
resp.recommendations[0].reference_links[0].text #=> String
resp.recommendations[0].reference_links[0].link #=> String
resp.marker #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The unique identifier of the Amazon Redshift cluster for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the account are returned.

  • :namespace_arn (String) —

    The Amazon Redshift cluster namespace Amazon Resource Name (ARN) for which the list of Advisor recommendations is returned. If the neither the cluster identifier and the cluster namespace ARN parameters are specified, then recommendations for all clusters in the 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.

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

Returns:

See Also:



8816
8817
8818
8819
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8816

def list_recommendations(params = {}, options = {})
  req = build_request(:list_recommendations, params)
  req.send_request(options)
end

#modify_aqua_configuration(params = {}) ⇒ Types::ModifyAquaOutputMessage

This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Examples:

Request syntax with placeholder values


resp = client.modify_aqua_configuration({
  cluster_identifier: "String", # required
  aqua_configuration_status: "enabled", # accepts enabled, disabled, auto
})

Response structure


resp.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The identifier of the cluster to be modified.

  • :aqua_configuration_status (String) —

    This parameter is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Returns:

See Also:



8852
8853
8854
8855
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8852

def modify_aqua_configuration(params = {}, options = {})
  req = build_request(:modify_aqua_configuration, params)
  req.send_request(options)
end

#modify_authentication_profile(params = {}) ⇒ Types::ModifyAuthenticationProfileResult

Modifies an authentication profile.

Examples:

Request syntax with placeholder values


resp = client.modify_authentication_profile({
  authentication_profile_name: "AuthenticationProfileNameString", # required
  authentication_profile_content: "String", # required
})

Response structure


resp.authentication_profile_name #=> String
resp.authentication_profile_content #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authentication_profile_name (required, String) —

    The name of the authentication profile to replace.

  • :authentication_profile_content (required, String) —

    The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

Returns:

See Also:



8888
8889
8890
8891
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 8888

def modify_authentication_profile(params = {}, options = {})
  req = build_request(:modify_authentication_profile, params)
  req.send_request(options)
end

#modify_cluster(params = {}) ⇒ 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 admin 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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:

  • Creating a public cluster

  • Restoring a public cluster

  • Modifying a private cluster to be public

  • Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User 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: "SensitiveString",
  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",
  availability_zone_relocation: false,
  availability_zone: "String",
  port: 1,
  manage_master_password: false,
  master_password_secret_kms_key_id: "String",
  ip_address_type: "String",
  multi_az: 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | 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 admin 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.

    You can't use MasterUserPassword if ManageMasterPassword is true.

    Operations never return the password, so this operation provides a way to regain access to the admin 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-126) except ' (single quote), " (double quote), `,/, or@`.

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

    You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

    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 Amazon Web Services 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.

    Default: false

  • :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 Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

  • :availability_zone_relocation (Boolean) —

    The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

  • :availability_zone (String) —

    The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

  • :port (Integer) —

    The option to change the port of an Amazon Redshift cluster.

    Valid Values:

    • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)

    • For clusters with dc2 nodes - Select a port within the range 1150-65535.

  • :manage_master_password (Boolean) —

    If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

  • :master_password_secret_kms_key_id (String) —

    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

  • :ip_address_type (String) —

    The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

  • :multi_az (Boolean) —

    If true and the cluster is currently only deployed in a single Availability Zone, the cluster will be modified to be deployed in two Availability Zones.

Returns:

See Also:



9405
9406
9407
9408
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9405

def modify_cluster(params = {}, options = {})
  req = build_request(:modify_cluster, params)
  req.send_request(options)
end

#modify_cluster_db_revision(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



9572
9573
9574
9575
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9572

def modify_cluster_db_revision(params = {}, options = {})
  req = build_request(:modify_cluster_db_revision, params)
  req.send_request(options)
end

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

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

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

Examples:

Request syntax with placeholder values


resp = client.modify_cluster_iam_roles({
  cluster_identifier: "String", # required
  add_iam_roles: ["String"],
  remove_iam_roles: ["String"],
  default_iam_role_arn: "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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

  • :remove_iam_roles (Array<String>) —

    Zero or more IAM roles in ARN format to disassociate from the cluster.

  • :default_iam_role_arn (String) —

    The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.

Returns:

See Also:



9755
9756
9757
9758
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9755

def modify_cluster_iam_roles(params = {}, options = {})
  req = build_request(:modify_cluster_iam_roles, params)
  req.send_request(options)
end

#modify_cluster_maintenance(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

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

  • :defer_maintenance_end_time (Time, DateTime, Date, Integer, String) —

    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:



9938
9939
9940
9941
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 9938

def modify_cluster_maintenance(params = {}, options = {})
  req = build_request(:modify_cluster_maintenance, params)
  req.send_request(options)
end

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

Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



10001
10002
10003
10004
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10001

def modify_cluster_parameter_group(params = {}, options = {})
  req = build_request(:modify_cluster_parameter_group, params)
  req.send_request(options)
end

#modify_cluster_snapshot(params = {}) ⇒ 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.engine_full_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 #=> Boolean
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshot.master_password_secret_arn #=> String
resp.snapshot.master_password_secret_kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



10088
10089
10090
10091
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10088

def modify_cluster_snapshot(params = {}, options = {})
  req = build_request(:modify_cluster_snapshot, params)
  req.send_request(options)
end

#modify_cluster_snapshot_schedule(params = {}) ⇒ 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,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



10121
10122
10123
10124
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10121

def modify_cluster_snapshot_schedule(params = {}, options = {})
  req = build_request(:modify_cluster_snapshot_schedule, params)
  req.send_request(options)
end

#modify_cluster_subnet_group(params = {}) ⇒ 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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:

  • Creating a public cluster

  • Restoring a public cluster

  • Modifying a private cluster to be public

  • Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

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
resp.cluster_subnet_group.supported_cluster_ip_address_types #=> Array
resp.cluster_subnet_group.supported_cluster_ip_address_types[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



10196
10197
10198
10199
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10196

def modify_cluster_subnet_group(params = {}, options = {})
  req = build_request(:modify_cluster_subnet_group, params)
  req.send_request(options)
end

#modify_custom_domain_association(params = {}) ⇒ Types::ModifyCustomDomainAssociationResult

Contains information for changing a custom domain association.

Examples:

Request syntax with placeholder values


resp = client.modify_custom_domain_association({
  custom_domain_name: "CustomDomainNameString", # required
  custom_domain_certificate_arn: "CustomDomainCertificateArnString", # required
  cluster_identifier: "String", # required
})

Response structure


resp.custom_domain_name #=> String
resp.custom_domain_certificate_arn #=> String
resp.cluster_identifier #=> String
resp.custom_domain_cert_expiry_time #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :custom_domain_name (required, String) —

    The custom domain name for a changed custom domain association.

  • :custom_domain_certificate_arn (required, String) —

    The certificate Amazon Resource Name (ARN) for the changed custom domain association.

  • :cluster_identifier (required, String) —

    The identifier of the cluster to change a custom domain association for.

Returns:

See Also:



10240
10241
10242
10243
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10240

def modify_custom_domain_association(params = {}, options = {})
  req = build_request(:modify_custom_domain_association, params)
  req.send_request(options)
end

#modify_endpoint_access(params = {}) ⇒ Types::EndpointAccess

Modifies a Redshift-managed VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.modify_endpoint_access({
  endpoint_name: "String", # required
  vpc_security_group_ids: ["String"],
})

Response structure


resp.cluster_identifier #=> String
resp.resource_owner #=> String
resp.subnet_group_name #=> String
resp.endpoint_status #=> String
resp.endpoint_name #=> String
resp.endpoint_create_time #=> Time
resp.port #=> Integer
resp.address #=> String
resp.vpc_security_groups #=> Array
resp.vpc_security_groups[0].vpc_security_group_id #=> String
resp.vpc_security_groups[0].status #=> String
resp.vpc_endpoint.vpc_endpoint_id #=> String
resp.vpc_endpoint.vpc_id #=> String
resp.vpc_endpoint.network_interfaces #=> Array
resp.vpc_endpoint.network_interfaces[0].network_interface_id #=> String
resp.vpc_endpoint.network_interfaces[0].subnet_id #=> String
resp.vpc_endpoint.network_interfaces[0].private_ip_address #=> String
resp.vpc_endpoint.network_interfaces[0].availability_zone #=> String
resp.vpc_endpoint.network_interfaces[0].ipv_6_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :endpoint_name (required, String) —

    The endpoint to be modified.

  • :vpc_security_group_ids (Array<String>) —

    The complete list of VPC security groups associated with the endpoint after the endpoint is modified.

Returns:

See Also:



10300
10301
10302
10303
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10300

def modify_endpoint_access(params = {}, options = {})
  req = build_request(:modify_endpoint_access, params)
  req.send_request(options)
end

#modify_event_subscription(params = {}) ⇒ 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 #=> Boolean
resp.event_subscription.tags #=> Array
resp.event_subscription.tags[0].key #=> String
resp.event_subscription.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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, pending

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



10391
10392
10393
10394
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10391

def modify_event_subscription(params = {}, options = {})
  req = build_request(:modify_event_subscription, params)
  req.send_request(options)
end

#modify_integration(params = {}) ⇒ Types::Integration

Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.

Examples:

Request syntax with placeholder values


resp = client.modify_integration({
  integration_arn: "IntegrationArn", # required
  description: "IntegrationDescription",
  integration_name: "IntegrationName",
})

Response structure


resp.integration_arn #=> String
resp.integration_name #=> String
resp.source_arn #=> String
resp.target_arn #=> String
resp.status #=> String, one of "creating", "active", "modifying", "failed", "deleting", "syncing", "needs_attention"
resp.errors #=> Array
resp.errors[0].error_code #=> String
resp.errors[0].error_message #=> String
resp.create_time #=> Time
resp.description #=> String
resp.kms_key_id #=> String
resp.additional_encryption_context #=> Hash
resp.additional_encryption_context["String"] #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :integration_arn (required, String) —

    The unique identifier of the integration to modify.

  • :description (String) —

    A new description for the integration.

  • :integration_name (String) —

    A new name for the integration.

Returns:

See Also:



10453
10454
10455
10456
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10453

def modify_integration(params = {}, options = {})
  req = build_request(:modify_integration, params)
  req.send_request(options)
end

#modify_redshift_idc_application(params = {}) ⇒ Types::ModifyRedshiftIdcApplicationResult

Changes an existing Amazon Redshift IAM Identity Center application.

Examples:

Request syntax with placeholder values


resp = client.modify_redshift_idc_application({
  redshift_idc_application_arn: "String", # required
  identity_namespace: "IdentityNamespaceString",
  iam_role_arn: "String",
  idc_display_name: "IdcDisplayNameString",
  authorized_token_issuer_list: [
    {
      trusted_token_issuer_arn: "String",
      authorized_audiences_list: ["String"],
    },
  ],
  service_integrations: [
    {
      lake_formation: [
        {
          lake_formation_query: {
            authorization: "Enabled", # required, accepts Enabled, Disabled
          },
        },
      ],
      s3_access_grants: [
        {
          read_write_access: {
            authorization: "Enabled", # required, accepts Enabled, Disabled
          },
        },
      ],
    },
  ],
})

Response structure


resp.redshift_idc_application.idc_instance_arn #=> String
resp.redshift_idc_application.redshift_idc_application_name #=> String
resp.redshift_idc_application.redshift_idc_application_arn #=> String
resp.redshift_idc_application.identity_namespace #=> String
resp.redshift_idc_application.idc_display_name #=> String
resp.redshift_idc_application.iam_role_arn #=> String
resp.redshift_idc_application.idc_managed_application_arn #=> String
resp.redshift_idc_application.idc_onboard_status #=> String
resp.redshift_idc_application.authorized_token_issuer_list #=> Array
resp.redshift_idc_application.authorized_token_issuer_list[0].trusted_token_issuer_arn #=> String
resp.redshift_idc_application.authorized_token_issuer_list[0].authorized_audiences_list #=> Array
resp.redshift_idc_application.authorized_token_issuer_list[0].authorized_audiences_list[0] #=> String
resp.redshift_idc_application.service_integrations #=> Array
resp.redshift_idc_application.service_integrations[0].lake_formation #=> Array
resp.redshift_idc_application.service_integrations[0].lake_formation[0].lake_formation_query.authorization #=> String, one of "Enabled", "Disabled"
resp.redshift_idc_application.service_integrations[0].s3_access_grants #=> Array
resp.redshift_idc_application.service_integrations[0].s3_access_grants[0].read_write_access.authorization #=> String, one of "Enabled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :redshift_idc_application_arn (required, String) —

    The ARN for the Redshift application that integrates with IAM Identity Center.

  • :identity_namespace (String) —

    The namespace for the Amazon Redshift IAM Identity Center application to change. It determines which managed application verifies the connection token.

  • :iam_role_arn (String) —

    The IAM role ARN associated with the Amazon Redshift IAM Identity Center application to change. It has the required permissions to be assumed and invoke the IDC Identity Center API.

  • :idc_display_name (String) —

    The display name for the Amazon Redshift IAM Identity Center application to change. It appears on the console.

  • :authorized_token_issuer_list (Array<Types::AuthorizedTokenIssuer>) —

    The authorized token issuer list for the Amazon Redshift IAM Identity Center application to change.

  • :service_integrations (Array<Types::ServiceIntegrationsUnion>) —

    A collection of service integrations associated with the application.

Returns:

See Also:



10546
10547
10548
10549
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10546

def modify_redshift_idc_application(params = {}, options = {})
  req = build_request(:modify_redshift_idc_application, params)
  req.send_request(options)
end

#modify_scheduled_action(params = {}) ⇒ 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,
      reserved_node_id: "String",
      target_reserved_node_offering_id: "String",
    },
    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 #=> Boolean
resp.target_action.resize_cluster.reserved_node_id #=> String
resp.target_action.resize_cluster.target_reserved_node_offering_id #=> String
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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, DateTime, Date, Integer, String) —

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

  • :end_time (Time, DateTime, Date, Integer, String) —

    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:



10649
10650
10651
10652
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10649

def modify_scheduled_action(params = {}, options = {})
  req = build_request(:modify_scheduled_action, params)
  req.send_request(options)
end

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

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services 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 Amazon Web Services Region after they are copied from the source Amazon Web Services 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 Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services 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:



10852
10853
10854
10855
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10852

def modify_snapshot_copy_retention_period(params = {}, options = {})
  req = build_request(:modify_snapshot_copy_retention_period, params)
  req.send_request(options)
end

#modify_snapshot_schedule(params = {}) ⇒ 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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



10905
10906
10907
10908
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10905

def modify_snapshot_schedule(params = {}, options = {})
  req = build_request(:modify_snapshot_schedule, params)
  req.send_request(options)
end

#modify_usage_limit(params = {}) ⇒ 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", "cross-region-datasharing"
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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



10960
10961
10962
10963
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 10960

def modify_usage_limit(params = {}, options = {})
  req = build_request(:modify_usage_limit, params)
  req.send_request(options)
end

#pause_cluster(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The identifier of the cluster to be paused.

Returns:

See Also:



11118
11119
11120
11121
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11118

def pause_cluster(params = {}, options = {})
  req = build_request(:pause_cluster, params)
  req.send_request(options)
end

#purchase_reserved_node_offering(params = {}) ⇒ 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"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



11179
11180
11181
11182
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11179

def purchase_reserved_node_offering(params = {}, options = {})
  req = build_request(:purchase_reserved_node_offering, params)
  req.send_request(options)
end

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult

Updates the resource policy for a specified resource.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "String", # required
  policy: "String", # required
})

Response structure


resp.resource_policy.resource_arn #=> String
resp.resource_policy.policy #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource of which its resource policy is updated.

  • :policy (required, String) —

    The content of the resource policy being updated.

Returns:

See Also:



11213
11214
11215
11216
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11213

def put_resource_policy(params = {}, options = {})
  req = build_request(:put_resource_policy, params)
  req.send_request(options)
end

#reboot_cluster(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The cluster identifier.

Returns:

See Also:



11381
11382
11383
11384
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11381

def reboot_cluster(params = {}, options = {})
  req = build_request(:reboot_cluster, params)
  req.send_request(options)
end

#register_namespace(params = {}) ⇒ Types::RegisterNamespaceOutputMessage

Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog.

Examples:

Request syntax with placeholder values


resp = client.register_namespace({
  namespace_identifier: { # required
    serverless_identifier: {
      namespace_identifier: "String", # required
      workgroup_identifier: "String", # required
    },
    provisioned_identifier: {
      cluster_identifier: "String", # required
    },
  },
  consumer_identifiers: ["String"], # required
})

Response structure


resp.status #=> String, one of "Registering", "Deregistering"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :namespace_identifier (required, Types::NamespaceIdentifierUnion) —

    The unique identifier of the cluster or serverless namespace that you want to register.

  • :consumer_identifiers (required, Array<String>) —

    An array containing the ID of the consumer account that you want to register the namespace to.

Returns:

See Also:



11424
11425
11426
11427
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11424

def register_namespace(params = {}, options = {})
  req = build_request(:register_namespace, params)
  req.send_request(options)
end

#reject_data_share(params = {}) ⇒ Types::DataShare

From a datashare consumer account, rejects the specified datashare.

Examples:

Request syntax with placeholder values


resp = client.reject_data_share({
  data_share_arn: "String", # required
})

Response structure


resp.data_share_arn #=> String
resp.producer_arn #=> String
resp.allow_publicly_accessible_consumers #=> Boolean
resp.data_share_associations #=> Array
resp.data_share_associations[0].consumer_identifier #=> String
resp.data_share_associations[0].status #=> String, one of "ACTIVE", "PENDING_AUTHORIZATION", "AUTHORIZED", "DEAUTHORIZED", "REJECTED", "AVAILABLE"
resp.data_share_associations[0].consumer_region #=> String
resp.data_share_associations[0].created_date #=> Time
resp.data_share_associations[0].status_change_date #=> Time
resp.data_share_associations[0].producer_allowed_writes #=> Boolean
resp.data_share_associations[0].consumer_accepted_writes #=> Boolean
resp.managed_by #=> String
resp.data_share_type #=> String, one of "INTERNAL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_share_arn (required, String) —

    The Amazon Resource Name (ARN) of the datashare to reject.

Returns:

See Also:



11469
11470
11471
11472
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11469

def reject_data_share(params = {}, options = {})
  req = build_request(:reject_data_share, params)
  req.send_request(options)
end

#reset_cluster_parameter_group(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



11530
11531
11532
11533
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11530

def reset_cluster_parameter_group(params = {}, options = {})
  req = build_request(:reset_cluster_parameter_group, params)
  req.send_request(options)
end

#resize_cluster(params = {}) ⇒ 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:

    • dc2.large

    • dc2.8xlarge

    • ra3.large

    • ra3.xlplus

    • 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,
  reserved_node_id: "String",
  target_reserved_node_offering_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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

  • :reserved_node_id (String) —

    The identifier of the reserved node.

  • :target_reserved_node_offering_id (String) —

    The identifier of the target reserved node offering.

Returns:

See Also:



11738
11739
11740
11741
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 11738

def resize_cluster(params = {}, options = {})
  req = build_request(:resize_cluster, params)
  req.send_request(options)
end

#restore_from_cluster_snapshot(params = {}) ⇒ 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.

VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. If a subnet group for a provisioned cluster is in an account with VPC BPA turned on, the following capabilities are blocked:

  • Creating a public cluster

  • Restoring a public cluster

  • Modifying a private cluster to be public

  • Adding a subnet with VPC BPA turned on to the subnet group when there's at least one public cluster within the group

For more information about VPC BPA, see Block public access to VPCs and subnets in the Amazon VPC User Guide.

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",
  snapshot_arn: "String",
  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,
  availability_zone_relocation: false,
  aqua_configuration_status: "enabled", # accepts enabled, disabled, auto
  default_iam_role_arn: "String",
  reserved_node_id: "String",
  target_reserved_node_offering_id: "String",
  encrypted: false,
  manage_master_password: false,
  master_password_secret_kms_key_id: "String",
  ip_address_type: "String",
  multi_az: 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services account.

  • :snapshot_identifier (String) —

    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn, but not both.

    Example: my-snapshot-id

  • :snapshot_arn (String) —

    The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier, but not both.

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

    Valid values: For clusters with DC2 nodes, must be within the range 1150-65535. For clusters with ra3 nodes, must be within the ranges 5431-5455 or 8191-8215.

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

    Default: false

  • :owner_account (String) —

    The Amazon Web Services 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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.

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

    You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

    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 Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.

  • :node_type (String) —

    The node type that the restored cluster will be provisioned with.

    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 dc2.large node type into another dc2 type. 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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

    The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

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

  • :availability_zone_relocation (Boolean) —

    The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

  • :aqua_configuration_status (String) —

    This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

  • :default_iam_role_arn (String) —

    The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.

  • :reserved_node_id (String) —

    The identifier of the target reserved node offering.

  • :target_reserved_node_offering_id (String) —

    The identifier of the target reserved node offering.

  • :encrypted (Boolean) —

    Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.

  • :manage_master_password (Boolean) —

    If true, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If ManageMasterPassword is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.

  • :master_password_secret_kms_key_id (String) —

    The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

  • :ip_address_type (String) —

    The IP address type for the cluster. Possible values are ipv4 and dualstack.

  • :multi_az (Boolean) —

    If true, the snapshot will be restored to a cluster deployed in two Availability Zones.

Returns:

See Also:



12243
12244
12245
12246
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12243

def restore_from_cluster_snapshot(params = {}, options = {})
  req = build_request(:restore_from_cluster_snapshot, params)
  req.send_request(options)
end

#restore_table_from_cluster_snapshot(params = {}) ⇒ 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.

You can't use this operation to restore tables with interleaved sort keys.

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
  enable_case_sensitive_identifier: false,
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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

  • :enable_case_sensitive_identifier (Boolean) —

    Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false (default), the names are not case sensitive.

Returns:

See Also:



12343
12344
12345
12346
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12343

def restore_table_from_cluster_snapshot(params = {}, options = {})
  req = build_request(:restore_table_from_cluster_snapshot, params)
  req.send_request(options)
end

#resume_cluster(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (required, String) —

    The identifier of the cluster to be resumed.

Returns:

See Also:



12501
12502
12503
12504
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12501

def resume_cluster(params = {}, options = {})
  req = build_request(:resume_cluster, params)
  req.send_request(options)
end

#revoke_cluster_security_group_ingress(params = {}) ⇒ 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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 Amazon Web Services account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services 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:



12578
12579
12580
12581
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12578

def revoke_cluster_security_group_ingress(params = {}, options = {})
  req = build_request(:revoke_cluster_security_group_ingress, params)
  req.send_request(options)
end

#revoke_endpoint_access(params = {}) ⇒ Types::EndpointAuthorization

Revokes access to a cluster.

Examples:

Request syntax with placeholder values


resp = client.revoke_endpoint_access({
  cluster_identifier: "String",
  account: "String",
  vpc_ids: ["String"],
  force: false,
})

Response structure


resp.grantor #=> String
resp.grantee #=> String
resp.cluster_identifier #=> String
resp.authorize_time #=> Time
resp.cluster_status #=> String
resp.status #=> String, one of "Authorized", "Revoking"
resp.allowed_all_vp_cs #=> Boolean
resp.allowed_vp_cs #=> Array
resp.allowed_vp_cs[0] #=> String
resp.endpoint_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cluster_identifier (String) —

    The cluster to revoke access from.

  • :account (String) —

    The Amazon Web Services account ID whose access is to be revoked.

  • :vpc_ids (Array<String>) —

    The virtual private cloud (VPC) identifiers for which access is to be revoked.

  • :force (Boolean) —

    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

Returns:

See Also:



12638
12639
12640
12641
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12638

def revoke_endpoint_access(params = {}, options = {})
  req = build_request(:revoke_endpoint_access, params)
  req.send_request(options)
end

#revoke_snapshot_access(params = {}) ⇒ Types::RevokeSnapshotAccessResult

Removes the ability of the specified Amazon Web Services 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",
  snapshot_arn: "String",
  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.engine_full_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 #=> Boolean
resp.snapshot.kms_key_id #=> String
resp.snapshot.encrypted_with_hsm #=> Boolean
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 #=> Boolean
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
resp.snapshot.master_password_secret_arn #=> String
resp.snapshot.master_password_secret_kms_key_id #=> String
resp.snapshot.snapshot_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :snapshot_identifier (String) —

    The identifier of the snapshot that the account can no longer access.

  • :snapshot_arn (String) —

    The Amazon Resource Name (ARN) of the snapshot associated with the message to revoke 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 Amazon Web Services account that can no longer restore the specified snapshot.

Returns:

See Also:



12734
12735
12736
12737
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12734

def revoke_snapshot_access(params = {}, options = {})
  req = build_request(:revoke_snapshot_access, params)
  req.send_request(options)
end

#rotate_encryption_key(params = {}) ⇒ 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.endpoint.vpc_endpoints #=> Array
resp.cluster.endpoint.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].vpc_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces #=> Array
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].network_interface_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].subnet_id #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].private_ip_address #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].availability_zone #=> String
resp.cluster.endpoint.vpc_endpoints[0].network_interfaces[0].ipv_6_address #=> String
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 #=> Boolean
resp.cluster.pending_modified_values.enhanced_vpc_routing #=> Boolean
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 #=> Boolean
resp.cluster.number_of_nodes #=> Integer
resp.cluster.publicly_accessible #=> Boolean
resp.cluster.encrypted #=> Boolean
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 #=> Boolean
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 #=> Boolean
resp.cluster.availability_zone_relocation_status #=> String
resp.cluster.cluster_namespace_arn #=> String
resp.cluster.total_storage_capacity_in_mega_bytes #=> Integer
resp.cluster.aqua_configuration.aqua_status #=> String, one of "enabled", "disabled", "applying"
resp.cluster.aqua_configuration.aqua_configuration_status #=> String, one of "enabled", "disabled", "auto"
resp.cluster.default_iam_role_arn #=> String
resp.cluster.reserved_node_exchange_status.reserved_node_exchange_request_id #=> String
resp.cluster.reserved_node_exchange_status.status #=> String, one of "REQUESTED", "PENDING", "IN_PROGRESS", "RETRYING", "SUCCEEDED", "FAILED"
resp.cluster.reserved_node_exchange_status.request_time #=> Time
resp.cluster.reserved_node_exchange_status.source_reserved_node_id #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.source_reserved_node_count #=> Integer
resp.cluster.reserved_node_exchange_status.target_reserved_node_offering_id #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_type #=> String
resp.cluster.reserved_node_exchange_status.target_reserved_node_count #=> Integer
resp.cluster.custom_domain_name #=> String
resp.cluster.custom_domain_certificate_arn #=> String
resp.cluster.custom_domain_certificate_expiry_date #=> Time
resp.cluster.master_password_secret_arn #=> String
resp.cluster.master_password_secret_kms_key_id #=> String
resp.cluster.ip_address_type #=> String
resp.cluster.multi_az #=> String
resp.cluster.multi_az_secondary.availability_zone #=> String
resp.cluster.multi_az_secondary.cluster_nodes #=> Array
resp.cluster.multi_az_secondary.cluster_nodes[0].node_role #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].private_ip_address #=> String
resp.cluster.multi_az_secondary.cluster_nodes[0].public_ip_address #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

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



12896
12897
12898
12899
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12896

def rotate_encryption_key(params = {}, options = {})
  req = build_request(:rotate_encryption_key, params)
  req.send_request(options)
end

#update_partner_status(params = {}) ⇒ Types::PartnerIntegrationOutputMessage

Updates the status of a partner integration.

Examples:

Request syntax with placeholder values


resp = client.update_partner_status({
  account_id: "PartnerIntegrationAccountId", # required
  cluster_identifier: "PartnerIntegrationClusterIdentifier", # required
  database_name: "PartnerIntegrationDatabaseName", # required
  partner_name: "PartnerIntegrationPartnerName", # required
  status: "Active", # required, accepts Active, Inactive, RuntimeFailure, ConnectionFailure
  status_message: "PartnerIntegrationStatusMessage",
})

Response structure


resp.database_name #=> String
resp.partner_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (required, String) —

    The Amazon Web Services account ID that owns the cluster.

  • :cluster_identifier (required, String) —

    The cluster identifier of the cluster whose partner integration status is being updated.

  • :database_name (required, String) —

    The name of the database whose partner integration status is being updated.

  • :partner_name (required, String) —

    The name of the partner whose integration status is being updated.

  • :status (required, String) —

    The value of the updated status.

  • :status_message (String) —

    The status message provided by the partner.

Returns:

See Also:



12948
12949
12950
12951
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 12948

def update_partner_status(params = {}, options = {})
  req = build_request(:update_partner_status, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

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(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
cluster_available #describe_clusters 60 30
cluster_deleted #describe_clusters 60 30
cluster_restored #describe_clusters 60 30
snapshot_available #describe_cluster_snapshots 15 20

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

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.



13066
13067
13068
13069
13070
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 13066

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end