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. This can be an 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.

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

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

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

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

    A Bearer Token Provider. This can be an 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.



444
445
446
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 444

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:



496
497
498
499
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 496

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:



542
543
544
545
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 542

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

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:



609
610
611
612
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 609

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:



695
696
697
698
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 695

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

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:



752
753
754
755
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 752

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:



805
806
807
808
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 805

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:



908
909
910
911
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 908

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:



948
949
950
951
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 948

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:



1000
1001
1002
1003
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1000

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:



1062
1063
1064
1065
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1062

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:



1194
1195
1196
1197
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1194

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:



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

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.

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

  • :encrypted (Boolean)

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

    Default: false

  • :hsm_client_certificate_identifier (String)

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

  • :hsm_configuration_identifier (String)

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

  • :elastic_ip (String)

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. 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:



1821
1822
1823
1824
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1821

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:



1910
1911
1912
1913
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1910

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:



1989
1990
1991
1992
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 1989

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:



2103
2104
2105
2106
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2103

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:



2184
2185
2186
2187
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2184

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:



2229
2230
2231
2232
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2229

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:



2308
2309
2310
2311
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2308

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:



2443
2444
2445
2446
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2443

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:



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

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:



2578
2579
2580
2581
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2578

def create_hsm_configuration(params = {}, options = {})
  req = build_request(:create_hsm_configuration, 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
          },
        },
      ],
    },
  ],
})

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"

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:



2668
2669
2670
2671
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2668

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:



2779
2780
2781
2782
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2779

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:



2850
2851
2852
2853
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2850

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:



2923
2924
2925
2926
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2923

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:



2967
2968
2969
2970
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 2967

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:



3052
3053
3054
3055
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3052

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

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:



3103
3104
3105
3106
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3103

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:



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

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:



3357
3358
3359
3360
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3357

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:



3390
3391
3392
3393
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3390

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:



3425
3426
3427
3428
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3425

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:



3515
3516
3517
3518
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3515

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:



3537
3538
3539
3540
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3537

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:



3565
3566
3567
3568
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3565

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:



3620
3621
3622
3623
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3620

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:



3643
3644
3645
3646
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3643

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:



3665
3666
3667
3668
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3665

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:



3687
3688
3689
3690
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3687

def delete_hsm_configuration(params = {}, options = {})
  req = build_request(:delete_hsm_configuration, 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:



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

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:



3754
3755
3756
3757
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3754

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:



3777
3778
3779
3780
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3777

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:



3799
3800
3801
3802
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3799

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:



3821
3822
3823
3824
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3821

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:



3843
3844
3845
3846
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3843

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:



3872
3873
3874
3875
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3872

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:



3894
3895
3896
3897
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3894

def delete_usage_limit(params = {}, options = {})
  req = build_request(:delete_usage_limit, 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:



3925
3926
3927
3928
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3925

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:



3956
3957
3958
3959
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 3956

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:



4023
4024
4025
4026
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4023

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:



4129
4130
4131
4132
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4129

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:



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

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:



4338
4339
4340
4341
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4338

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:



4553
4554
4555
4556
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4553

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:



4656
4657
4658
4659
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4656

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:



4709
4710
4711
4712
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4709

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:



4789
4790
4791
4792
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 4789

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:



5025
5026
5027
5028
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5025

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:



5075
5076
5077
5078
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5075

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



5139
5140
5141
5142
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5139

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



5209
5210
5211
5212
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5209

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



5279
5280
5281
5282
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5279

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:



5351
5352
5353
5354
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5351

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:



5428
5429
5430
5431
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/client.rb', line 5428

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: