RubyDoc.info: Class: Aws::Redshift::Client – Documentation for aws-sdk-redshift (1.0.0)

#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 AWS region.

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

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

[1]: en.wikipedia.org/wiki/Classless_Inter-Domain_Routing [2]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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 AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Example: 111122223333

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 229

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

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

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

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> 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].account_id #=> String
resp.snapshot.accounts_with_restore_access[0].account_alias #=> String
resp.snapshot.owner_account #=> 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

Options Hash (params):

:snapshot_identifier (required, String) —

The identifier of the snapshot the account is authorized to restore.
:snapshot_cluster_identifier (String) —

The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
:account_with_restore_access (required, String) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 313

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

#build_request(operation_name, params = {}) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-redshift/client.rb', line 6110

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-redshift'
  context[:gem_version] = '1.0.0'
  Seahorse::Client::Request.new(handlers, context)
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*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html

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
})

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> 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].account_id #=> String
resp.snapshot.accounts_with_restore_access[0].account_alias #=> String
resp.snapshot.owner_account #=> 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

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 AWS account that is making the request.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 427

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

#create_cluster(params = {}) ⇒ `Types::CreateClusterResult`

Creates a new cluster.

To create the 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*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

Examples:

Request syntax with placeholder values


resp = client.create_cluster({
  db_name: "String",
  cluster_identifier: "String", # required
  cluster_type: "String",
  node_type: "String", # required
  master_username: "String", # required
  master_user_password: "String", # required
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  cluster_subnet_group_name: "String",
  availability_zone: "String",
  preferred_maintenance_window: "String",
  cluster_parameter_group_name: "String",
  automated_snapshot_retention_period: 1,
  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"],
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

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.
[1]: docs.aws.amazon.com/redshift/latest/dg/t_creating_database.html [2]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html
:cluster_identifier (required, String) —
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- Alphabetic characters must be lowercase.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Must be unique for all clusters within an AWS account.
Example: myexamplecluster
:cluster_type (String) —
The type of the cluster. When cluster type is specified as
- single-node, the NumberOfNodes parameter is not required.
- multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node

Default: multi-node
:node_type (required, String) —

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

Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes
:master_username (required, String) —
The user name associated with the master user account for the cluster that is being created.

Constraints:
- Must be 1 - 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word. A list of reserved words can be found in
  
  Reserved Words][1
  
  in the Amazon Redshift Database Developer Guide.
[1]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html
:master_user_password (required, String) —
The password associated with the master user account for the cluster that is being created.

Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33 to 126) except ‘ (single quote), “ (double quote), \, /, @, or space.
:cluster_security_groups (Array<String>) —

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

Default: The default cluster security group for Amazon Redshift.
:vpc_security_group_ids (Array<String>) —

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

Default: The default VPC security group is associated with the cluster.
:cluster_subnet_group_name (String) —

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

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

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

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

Example: us-east-1d

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.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows
: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.
[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html
:automated_snapshot_retention_period (Integer) —

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

Default: 1

Constraints: Must be a value from 0 to 35.
:port (Integer) —

The port number on which the cluster accepts incoming connections.

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

Default: 5439

Valid Values: 1150-65535
:cluster_version (String) —

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0
:allow_version_upgrade (Boolean) —

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

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

Default: true
:number_of_nodes (Integer) —

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

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

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

Default: 1

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#how-many-nodes
:publicly_accessible (Boolean) —

If true, the cluster can be accessed from a public network.
:encrypted (Boolean) —

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

Default: false
:hsm_client_certificate_identifier (String) —

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
:hsm_configuration_identifier (String) —

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
:elastic_ip (String) —

The Elastic IP (EIP) address for the cluster.

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms
:tags (Array<Types::Tag>) —

A list of tag instances.
:kms_key_id (String) —

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
:enhanced_vpc_routing (Boolean) —

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see

Enhanced VPC Routing][1

in the Amazon Redshift Cluster Management

Guide.

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

Default: false

[1]: docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html
:additional_info (String) —

Reserved.
:iam_roles (Array<String>) —

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 862

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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 AWS account.
<note markdown=“1”> This value is stored as a lower-case string.
```
</note>
```
:parameter_group_family (required, String) —

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

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

A description of the parameter group.
:tags (Array<Types::Tag>) —

A list of tag instances.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 951

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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 AWS account.
Example: examplesecuritygroup
:description (required, String) —

A description for the security group.
:tags (Array<Types::Tag>) —

A list of tag instances.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1030

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> 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].account_id #=> String
resp.snapshot.accounts_with_restore_access[0].account_alias #=> String
resp.snapshot.owner_account #=> 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

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

Constraints:
- Cannot be null, empty, or blank
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
:cluster_identifier (required, String) —

The cluster identifier for which you want a snapshot.
:tags (Array<Types::Tag>) —

A list of tag instances.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1126

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html

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_status #=> String
resp.cluster_subnet_group.tags #=> Array
resp.cluster_subnet_group.tags[0].key #=> String
resp.cluster_subnet_group.tags[0].value #=> String

Options Hash (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 AWS account.
Example: examplesubnetgroup
:description (required, String) —

A description for the subnet group.
:subnet_ids (required, Array<String>) —

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
:tags (Array<Types::Tag>) —

A list of tag instances.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1203

def create_cluster_subnet_group(params = {}, options = {})
  req = build_request(:create_cluster_subnet_group, 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 AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

Examples:

Request syntax with placeholder values


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

Response structure


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

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 AWS account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
:source_ids (Array<String>) —

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

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

Example: my-snapshot-20131010
:event_categories (Array<String>) —

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

Values: Configuration, Management, Monitoring, Security
:severity (String) —

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

Values: ERROR, INFO
:enabled (Boolean) —

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
:tags (Array<Types::Tag>) —

A list of tag instances.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1336

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.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1392

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.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1471

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

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

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

For more information about managing snapshot copy grants, go to

Amazon Redshift Database Encryption][1: in the *Amazon Redshift

Cluster Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:snapshot_copy_grant_name (required, String) —
The name of the snapshot copy grant. This name must be unique in the region for the AWS account.

Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- Alphabetic characters must be lowercase.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Must be unique for all clusters within an AWS account.
:kms_key_id (String) —

The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
:tags (Array<Types::Tag>) —

A list of tag instances.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1541

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

#create_tags(params = {}) ⇒ `Struct`

Adds one or more tags to a specified resource.

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

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

Examples:

Request syntax with placeholder values


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

Options Hash (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-1: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”`.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1585

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

#delete_cluster(params = {}) ⇒ `Types::DeleteClusterResult`

Deletes a previously provisioned cluster. 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*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

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.

<note markdown=“1”> The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.
```
</note>
```
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.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1739

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.

<note markdown=“1”> You cannot delete a parameter group if it is associated with a cluster.

</note>

Examples:

Request syntax with placeholder values


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

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.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1772

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.

<note markdown=“1”> You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

</note>

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html

Examples:

Request syntax with placeholder values


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

Options Hash (params):

:cluster_security_group_name (required, String) —

The name of the cluster security group to be deleted.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1807

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.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].account_id #=> String
resp.snapshot.accounts_with_restore_access[0].account_alias #=> String
resp.snapshot.owner_account #=> 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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1889

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
})

Options Hash (params):

:cluster_subnet_group_name (required, String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1911

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

Options Hash (params):

:subscription_name (required, String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1934

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
})

Options Hash (params):

:hsm_client_certificate_identifier (required, String) —

The identifier of the HSM client certificate to be deleted.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1956

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
})

Options Hash (params):

:hsm_configuration_identifier (required, String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 1978

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

Options Hash (params):

:snapshot_copy_grant_name (required, String) —

The name of the snapshot copy grant to delete.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2000

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

#delete_tags(params = {}) ⇒ `Struct`

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

Examples:

Request syntax with placeholder values


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

Options Hash (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-1:123456789:cluster:t1.
:tag_keys (required, Array<String>) —

The tag key that you want to delete.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2029

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
:tag_keys (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2133

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][1: in the *Amazon Redshift Cluster

Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

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

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2220

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.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:cluster_security_group_name (String) —

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

Example: securitygroup1
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
:tag_keys (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2338

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 you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

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

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

Examples:

Request syntax with placeholder values


resp = client.describe_cluster_snapshots({
  cluster_identifier: "String",
  snapshot_identifier: "String",
  snapshot_type: "String",
  start_time: Time.now,
  end_time: Time.now,
  max_records: 1,
  marker: "String",
  owner_account: "String",
  tag_keys: ["String"],
  tag_values: ["String"],
})

Response structure


resp.marker #=> String
resp.snapshots #=> Array
resp.snapshots[0].snapshot_identifier #=> String
resp.snapshots[0].cluster_identifier #=> String
resp.snapshots[0].snapshot_create_time #=> Time
resp.snapshots[0].status #=> String
resp.snapshots[0].port #=> Integer
resp.snapshots[0].availability_zone #=> String
resp.snapshots[0].cluster_create_time #=> Time
resp.snapshots[0].master_username #=> String
resp.snapshots[0].cluster_version #=> String
resp.snapshots[0].snapshot_type #=> String
resp.snapshots[0].node_type #=> String
resp.snapshots[0].number_of_nodes #=> Integer
resp.snapshots[0].db_name #=> String
resp.snapshots[0].vpc_id #=> String
resp.snapshots[0].encrypted #=> 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].account_id #=> String
resp.snapshots[0].accounts_with_restore_access[0].account_alias #=> String
resp.snapshots[0].owner_account #=> 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

Options Hash (params):

:cluster_identifier (String) —

The identifier of the cluster for which information about snapshots is requested.
:snapshot_identifier (String) —

The snapshot identifier of the snapshot about which to return information.
:snapshot_type (String) —

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

Valid Values: automated | manual
:start_time (Time, 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

[1]: en.wikipedia.org/wiki/ISO_8601
: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

[1]: en.wikipedia.org/wiki/ISO_8601
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
:tag_keys (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2505

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 you AWS account.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
:tag_keys (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2602

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2679

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.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

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].modify_status #=> String
resp.clusters[0].master_username #=> String
resp.clusters[0].db_name #=> String
resp.clusters[0].endpoint.address #=> String
resp.clusters[0].endpoint.port #=> Integer
resp.clusters[0].cluster_create_time #=> Time
resp.clusters[0].automated_snapshot_retention_period #=> Integer
resp.clusters[0].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].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].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.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

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
:tag_keys (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2843

def describe_clusters(params = {}, options = {})
  req = build_request(:describe_clusters, 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][1: in the *Amazon Redshift Cluster

Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

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

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, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2913

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

#describe_event_categories(params = {}) ⇒ `Types::EventCategoriesMessage`

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:source_type (String) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 2958

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

#describe_event_subscriptions(params = {}) ⇒ `Types::EventSubscriptionsMessage`

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:subscription_name (String) —

The name of the Amazon Redshift event notification subscription to be described.
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3028

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

#describe_events(params = {}) ⇒ `Types::EventsMessage`

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

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

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.
- Specify a cluster identifier when SourceType is cluster.
- Specify a cluster security group name when SourceType is cluster-security-group.
- Specify a cluster parameter group name when SourceType is cluster-parameter-group.
- Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
:source_type (String) —
The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.
- Specify cluster when SourceIdentifier is a cluster identifier.
- Specify cluster-security-group when SourceIdentifier is a cluster security group name.
- Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.
- Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
:start_time (Time, DateTime, Date, Integer, String) —

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

ISO8601 Wikipedia page.][1

Example: 2009-07-08T18:00Z

[1]: en.wikipedia.org/wiki/ISO_8601
:end_time (Time, DateTime, Date, Integer, String) —

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

ISO8601 Wikipedia page.][1

Example: 2009-07-08T18:00Z

[1]: en.wikipedia.org/wiki/ISO_8601
:duration (Integer) —

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

Default: 60
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3161

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

#describe_hsm_client_certificates(params = {}) ⇒ `Types::HsmClientCertificateMessage`

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:hsm_client_certificate_identifier (String) —

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

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3253

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

#describe_hsm_configurations(params = {}) ⇒ `Types::HsmConfigurationMessage`

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:hsm_configuration_identifier (String) —

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

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3348

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

#describe_logging_status(params = {}) ⇒ `Types::LoggingStatus`

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_enabled #=> Boolean
resp.bucket_name #=> String
resp.s3_key_prefix #=> String
resp.last_successful_delivery_time #=> Time
resp.last_failure_time #=> Time
resp.last_failure_message #=> String

Options Hash (params):

:cluster_identifier (required, String) —

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

Example: examplecluster

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3389

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

#describe_orderable_cluster_options(params = {}) ⇒ `Types::OrderableClusterOptionsMessage`

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:cluster_version (String) —

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

Default: All versions.

Constraints: Must be one of the version returned from DescribeClusterVersions.
:node_type (String) —

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3469

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

#describe_reserved_node_offerings(params = {}) ⇒ `Types::ReservedNodeOfferingsMessage`

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

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.marker #=> String
resp.reserved_node_offerings #=> Array
resp.reserved_node_offerings[0].reserved_node_offering_id #=> String
resp.reserved_node_offerings[0].node_type #=> String
resp.reserved_node_offerings[0].duration #=> Integer
resp.reserved_node_offerings[0].fixed_price #=> Float
resp.reserved_node_offerings[0].usage_price #=> Float
resp.reserved_node_offerings[0].currency_code #=> String
resp.reserved_node_offerings[0].offering_type #=> String
resp.reserved_node_offerings[0].recurring_charges #=> Array
resp.reserved_node_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_node_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String

Options Hash (params):

:reserved_node_offering_id (String) —

The unique identifier for the offering.
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3544

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

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

Returns the descriptions of the reserved nodes.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:reserved_node_id (String) —

Identifier for the node reservation.
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3609

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

#describe_resize(params = {}) ⇒ `Types::ResizeProgressMessage`

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:cluster_identifier (required, String) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3673

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

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

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

For more information about managing snapshot copy grants, go to

Amazon Redshift Database Encryption][1: in the *Amazon Redshift

Cluster Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:snapshot_copy_grant_name (String) —

The name of the snapshot copy grant.
:max_records (Integer) —

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

Default: 100

Constraints: minimum 20, maximum 100.
:marker (String) —

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

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
:tag_keys (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3760

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

#describe_table_restore_status(params = {}) ⇒ `Types::TableRestoreStatusMessage`

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:cluster_identifier (String) —

The Amazon Redshift cluster that the table is being restored to.
:table_restore_request_id (String) —

The identifier of the table restore request to return status for. If you don’t specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.
:max_records (Integer) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3831

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

#describe_tags(params = {}) ⇒ `Types::TaggedResourceListMessage`

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

The following are limitations for DescribeTags:

You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:resource_name (String) —

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.
:resource_type (String) —
The type of resource with which you want to view tags. Valid resource types are:
- Cluster
- CIDR/IP
- EC2 security group
- Snapshot
- Cluster security group
- Subnet group
- HSM connection
- HSM certificate
- Parameter group
- Snapshot copy grant
For more information about Amazon Redshift resource types and constructing ARNs, go to [Constructing an Amazon Redshift Amazon Resource Name (ARN)] in the Amazon Redshift Cluster Management Guide.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/constructing-redshift-arn.html
:max_records (Integer) —

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

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

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 3959

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

#disable_logging(params = {}) ⇒ `Types::LoggingStatus`

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_enabled #=> Boolean
resp.bucket_name #=> String
resp.s3_key_prefix #=> String
resp.last_successful_delivery_time #=> Time
resp.last_failure_time #=> Time
resp.last_failure_message #=> String

Options Hash (params):

:cluster_identifier (required, String) —

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

Example: examplecluster

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4000

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

#disable_snapshot_copy(params = {}) ⇒ `Types::DisableSnapshotCopyResult`

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4106

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

#enable_logging(params = {}) ⇒ `Types::LoggingStatus`

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.logging_enabled #=> Boolean
resp.bucket_name #=> String
resp.s3_key_prefix #=> String
resp.last_successful_delivery_time #=> Time
resp.last_failure_time #=> Time
resp.last_failure_message #=> String

Options Hash (params):

:cluster_identifier (required, String) —

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

Example: examplecluster
:bucket_name (required, String) —
The name of an existing S3 bucket where the log files are to be stored.

Constraints:
- Must be in the same region as the cluster
- The cluster must have read bucket and put object permissions
:s3_key_prefix (String) —
The prefix applied to the log file names.

Constraints:
- Cannot exceed 512 characters
- Cannot contain spaces( ), double quotes (“), single quotes (‘), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
  - x00 to x20
  - x22
  - x27
  - x5c
  - x7f or larger

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4180

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

#enable_snapshot_copy(params = {}) ⇒ `Types::EnableSnapshotCopyResult`

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

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

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
:destination_region (required, String) —

The destination region that you want to copy snapshots to.

Constraints: Must be the name of a valid region. For more information, see [Regions and Endpoints] in the Amazon Web Services General Reference.

[1]: docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region
:retention_period (Integer) —

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

Default: 7.

Constraints: Must be at least 1 and no more than 35.
:snapshot_copy_grant_name (String) —

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4306

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

#get_cluster_credentials(params = {}) ⇒ `Types::ClusterCredentials`

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

The IAM user or role that executes GetClusterCredentials must have an IAM policy attached that allows the redshift:GetClusterCredentials action with access to the dbuser resource on the cluster. The user name specified for dbuser in the IAM policy and the user name specified for the DbUser parameter must match.

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

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

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

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

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

Constraints:
- Must be 1 to 128 alphanumeric characters or hyphens
- Must contain only lowercase letters.
- First character must be a letter.
- Must not contain a colon ( : ) or slash ( / ).
- Cannot be a reserved word. A list of reserved words can be found in
  
  Reserved Words][2
  
  in the Amazon Redshift Database Developer Guide.
[1]: docs.aws.amazon.com/http:/docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html [2]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html
:db_name (String) —
The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log in to any existing database.

Constraints:
- Must be 1 to 64 alphanumeric characters or hyphens
- Must contain only lowercase letters.
- Cannot be a reserved word. A list of reserved words can be found in
  
  Reserved Words][1
  
  in the Amazon Redshift Database Developer Guide.
[1]: docs.aws.amazon.com/redshift/latest/dg/r_pg_keywords.html
:cluster_identifier (required, String) —

The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.
:duration_seconds (Integer) —

The number of seconds until the returned temporary password expires.

Constraint: minimum 900, maximum 3600.

Default: 900
:auto_create (Boolean) —

Create a database user with the name specified for DbUser if one does not exist.
:db_groups (Array<String>) —

A list of the names of existing database groups that DbUser will join for the current session. If not specified, the new user is added only to PUBLIC.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4434

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

#modify_cluster(params = {}) ⇒ `Types::ModifyClusterResult`

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to [Amazon Redshift Clusters] in the *Amazon Redshift Cluster Management Guide*.

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

The unique identifier of the cluster to be modified.

Example: examplecluster
:cluster_type (String) —

The new cluster type.

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

Valid Values: ‘ multi-node | single-node `
:node_type (String) —

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

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: ‘ ds1.xlarge` | ds1.8xlarge | ` ds2.xlarge` | ds2.8xlarge | dc1.large | dc1.8xlarge.
:number_of_nodes (Integer) —

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

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: Integer greater than 0.
:cluster_security_groups (Array<String>) —
A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

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

Constraints:
- Must be 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
:vpc_security_group_ids (Array<String>) —

A list of virtual private cloud (VPC) security groups to be associated with the cluster.
:master_user_password (String) —
The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

<note markdown=“1”> Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.
```
</note>
```
Default: Uses existing setting.

Constraints:
- Must be between 8 and 64 characters in length.
- Must contain at least one uppercase letter.
- Must contain at least one lowercase letter.
- Must contain one number.
- Can be any printable ASCII character (ASCII code 33 to 126) except ‘ (single quote), “ (double quote), \, /, @, or space.
:cluster_parameter_group_name (String) —

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

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
:automated_snapshot_retention_period (Integer) —

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

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

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.
:preferred_maintenance_window (String) —

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

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

Default: Uses existing setting.

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

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

Constraints: Must be at least 30 minutes.
:cluster_version (String) —

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

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

Example: 1.0

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html
:allow_version_upgrade (Boolean) —

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

Default: false
:hsm_client_certificate_identifier (String) —

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
:hsm_configuration_identifier (String) —

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
:new_cluster_identifier (String) —
The new identifier for the cluster.

Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- Alphabetic characters must be lowercase.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Must be unique for all clusters within an AWS account.
Example: examplecluster
:publicly_accessible (Boolean) —

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
:elastic_ip (String) —

The Elastic IP (EIP) address for the cluster.

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#cluster-platforms
: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][1

in the Amazon Redshift Cluster Management

Guide.

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

Default: false

[1]: docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4778

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

#modify_cluster_iam_roles(params = {}) ⇒ `Types::ModifyClusterIamRolesResult`

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

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
:add_iam_roles (Array<String>) —

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4890

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

#modify_cluster_parameter_group(params = {}) ⇒ `Types::ClusterParameterGroupNameMessage`

Modifies the parameters of a parameter group.

For more information about parameters and parameter groups, go to

Amazon Redshift Parameter Groups][1: in the *Amazon Redshift Cluster

Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:parameter_group_name (required, String) —

The name of the parameter group to be modified.
:parameters (required, Array<Types::Parameter>) —

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

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 4952

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

#modify_cluster_subnet_group(params = {}) ⇒ `Types::ModifyClusterSubnetGroupResult`

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:cluster_subnet_group_name (required, String) —

The name of the subnet group to be modified.
:description (String) —

A text description of the subnet group to be modified.
:subnet_ids (required, Array<String>) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5001

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

#modify_event_subscription(params = {}) ⇒ `Types::ModifyEventSubscriptionResult`

Modifies an existing Amazon Redshift event notification subscription.

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:subscription_name (required, String) —

The name of the modified Amazon Redshift event notification subscription.
:sns_topic_arn (String) —

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

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

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.
:source_ids (Array<String>) —

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

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

Example: my-snapshot-20131010
:event_categories (Array<String>) —

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

Values: Configuration, Management, Monitoring, Security
:severity (String) —

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

Values: ERROR, INFO
:enabled (Boolean) —

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5091

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

#modify_snapshot_copy_retention_period(params = {}) ⇒ `Types::ModifySnapshotCopyRetentionPeriodResult`

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
:retention_period (required, Integer) —

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

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

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5205

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

#purchase_reserved_node_offering(params = {}) ⇒ `Types::PurchaseReservedNodeOfferingResult`

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

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:reserved_node_offering_id (required, String) —

The unique identifier of the reserved node offering you want to purchase.
:node_count (Integer) —

The number of reserved nodes that you want to purchase.

Default: 1

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5265

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

#reboot_cluster(params = {}) ⇒ `Types::RebootClusterResult`

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

The cluster identifier.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5371

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

#reset_cluster_parameter_group(params = {}) ⇒ `Types::ClusterParameterGroupNameMessage`

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:parameter_group_name (required, String) —

The name of the cluster parameter group to be reset.
:reset_all_parameters (Boolean) —

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

Default: true
:parameters (Array<Types::Parameter>) —

An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

Constraints: A maximum of 20 parameters can be reset in a single request.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5432

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

#restore_from_cluster_snapshot(params = {}) ⇒ `Types::RestoreFromClusterSnapshotResult`

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html

Examples:

Request syntax with placeholder values


resp = client.restore_from_cluster_snapshot({
  cluster_identifier: "String", # required
  snapshot_identifier: "String", # required
  snapshot_cluster_identifier: "String",
  port: 1,
  availability_zone: "String",
  allow_version_upgrade: false,
  cluster_subnet_group_name: "String",
  publicly_accessible: false,
  owner_account: "String",
  hsm_client_certificate_identifier: "String",
  hsm_configuration_identifier: "String",
  elastic_ip: "String",
  cluster_parameter_group_name: "String",
  cluster_security_groups: ["String"],
  vpc_security_group_ids: ["String"],
  preferred_maintenance_window: "String",
  automated_snapshot_retention_period: 1,
  kms_key_id: "String",
  node_type: "String",
  enhanced_vpc_routing: false,
  additional_info: "String",
  iam_roles: ["String"],
})

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —
The identifier of the cluster that will be created from restoring the snapshot.

Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens.
- Alphabetic characters must be lowercase.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
- Must be unique for all clusters within an AWS account.
:snapshot_identifier (required, String) —

The name of the snapshot from which to create the new cluster. This parameter isn’t case sensitive.

Example: my-snapshot-id
:snapshot_cluster_identifier (String) —

The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
:port (Integer) —

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.
:availability_zone (String) —

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-1a
:allow_version_upgrade (Boolean) —

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

Default: true
:cluster_subnet_group_name (String) —

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
:publicly_accessible (Boolean) —

If true, the cluster can be accessed from a public network.
:owner_account (String) —

The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
:hsm_client_certificate_identifier (String) —

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
:hsm_configuration_identifier (String) —

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
:elastic_ip (String) —

The elastic IP (EIP) address for the cluster.
:cluster_parameter_group_name (String) —
The name of the parameter group to be associated with this cluster.

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

Constraints:
- Must be 1 to 255 alphanumeric characters or hyphens.
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html
:cluster_security_groups (Array<String>) —

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

Default: The default cluster security group for Amazon Redshift.

Cluster security groups only apply to clusters outside of VPCs.
:vpc_security_group_ids (Array<String>) —

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

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

VPC security groups only apply to clusters in VPCs.
:preferred_maintenance_window (String) —

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

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

Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see [Maintenance Windows] in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-maintenance-windows
:automated_snapshot_retention_period (Integer) —

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

Default: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.
:kms_key_id (String) —

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
:node_type (String) —

The node type that the restored cluster will be provisioned with.

Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see [ About Clusters and Nodes] in the *Amazon Redshift Cluster Management Guide*

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-about-clusters-and-nodes
: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][1

in the Amazon Redshift Cluster Management

Guide.

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

Default: false

[1]: docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html
:additional_info (String) —

Reserved.
:iam_roles (Array<String>) —

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

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

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5754

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

#restore_table_from_cluster_snapshot(params = {}) ⇒ `Types::RestoreTableFromClusterSnapshotResult`

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

Examples:

Request syntax with placeholder values


resp = client.restore_table_from_cluster_snapshot({
  cluster_identifier: "String", # required
  snapshot_identifier: "String", # required
  source_database_name: "String", # required
  source_schema_name: "String",
  source_table_name: "String", # required
  target_database_name: "String",
  target_schema_name: "String",
  new_table_name: "String", # required
})

Response structure


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

Options Hash (params):

:cluster_identifier (required, String) —

The identifier of the Amazon Redshift cluster to restore the table to.
:snapshot_identifier (required, String) —

The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.
:source_database_name (required, String) —

The name of the source database that contains the table to restore from.
:source_schema_name (String) —

The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.
:source_table_name (required, String) —

The name of the source table to restore from.
:target_database_name (String) —

The name of the database to restore the table to.
:target_schema_name (String) —

The name of the schema to restore the table to.
:new_table_name (required, String) —

The name of the table to create as a result of the current request.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5841

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

#revoke_cluster_security_group_ingress(params = {}) ⇒ `Types::RevokeClusterSecurityGroupIngressResult`

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to [Amazon Redshift Cluster Security Groups] in the *Amazon Redshift Cluster Management Guide*.

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html

Examples:

Request syntax with placeholder values


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

Response structure


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

Options Hash (params):

:cluster_security_group_name (required, String) —

The name of the security Group from which to revoke the ingress rule.
:cidrip (String) —

The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
:ec2_security_group_name (String) —

The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
:ec2_security_group_owner_id (String) —

The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

Example: 111122223333

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 5918

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

#revoke_snapshot_access(params = {}) ⇒ `Types::RevokeSnapshotAccessResult`

Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

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

[1]: docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html

Examples:

Request syntax with placeholder values


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

Response structure


resp.snapshot.snapshot_identifier #=> String
resp.snapshot.cluster_identifier #=> String
resp.snapshot.snapshot_create_time #=> Time
resp.snapshot.status #=> String
resp.snapshot.port #=> Integer
resp.snapshot.availability_zone #=> String
resp.snapshot.cluster_create_time #=> Time
resp.snapshot.master_username #=> String
resp.snapshot.cluster_version #=> String
resp.snapshot.snapshot_type #=> String
resp.snapshot.node_type #=> String
resp.snapshot.number_of_nodes #=> Integer
resp.snapshot.db_name #=> String
resp.snapshot.vpc_id #=> String
resp.snapshot.encrypted #=> 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].account_id #=> String
resp.snapshot.accounts_with_restore_access[0].account_alias #=> String
resp.snapshot.owner_account #=> 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

Options Hash (params):

:snapshot_identifier (required, String) —

The identifier of the snapshot that the account can no longer access.
:snapshot_cluster_identifier (String) —

The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
:account_with_restore_access (required, String) —

The identifier of the AWS customer account that can no longer restore the specified snapshot.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 6001

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

#rotate_encryption_key(params = {}) ⇒ `Types::RotateEncryptionKeyResult`

Rotates the encryption keys for a cluster.

Examples:

Request syntax with placeholder values


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

Response structure


resp.cluster.cluster_identifier #=> String
resp.cluster.node_type #=> String
resp.cluster.cluster_status #=> String
resp.cluster.modify_status #=> String
resp.cluster.master_username #=> String
resp.cluster.db_name #=> String
resp.cluster.endpoint.address #=> String
resp.cluster.endpoint.port #=> Integer
resp.cluster.cluster_create_time #=> Time
resp.cluster.automated_snapshot_retention_period #=> Integer
resp.cluster.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.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.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.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

Options Hash (params):

:cluster_identifier (required, String) —

The unique identifier of the cluster that you want to rotate the encryption keys for.

Constraints: Must be the name of valid cluster that has encryption enabled.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-redshift/client.rb', line 6101

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

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ `Boolean`

Polls an API operation until a resource enters a desired state.

## Basic Usage

A waiter will call an API operation until:

It is successful
It enters a terminal state
It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

## Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

## Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

| waiter_name | params | :delay | :max_attempts | | —————— | —————————– | ——– | ————- | | cluster_available | #describe_clusters | 60 | 30 | | cluster_deleted | #describe_clusters | 60 | 30 | | cluster_restored | #describe_clusters | 60 | 30 | | snapshot_available | #describe_cluster_snapshots | 15 | 20 |

Options Hash (options):

:max_attempts (Integer)
:delay (Integer)
:before_attempt (Proc)
:before_wait (Proc)

Yields:

(w.waiter)

Raises:

(Errors::FailureStateError) —

Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —

Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —

Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —

Raised when you request to wait for an unknown state.

# File 'lib/aws-sdk-redshift/client.rb', line 6214

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

#waiter_names ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.



6222
6223
6224

# File 'lib/aws-sdk-redshift/client.rb', line 6222

def waiter_names
  waiters.keys
end

Class: Aws::Redshift::Client

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

#build_request(operation_name, params = {}) ⇒ Object

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

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

Examples:

Request syntax with placeholder values

Response structure

#create_tags(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

Response structure

#delete_cluster_parameter_group(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

#delete_cluster_security_group(params = {}) ⇒ Struct

Examples:

Request syntax with placeholder values

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

Examples:

Request syntax with placeholder values

Response structure

#delete_cluster_subnet_group(params = {}) ⇒ Struct

Examples:

#initialize(*args) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#authorize_cluster_security_group_ingress(params = {}) ⇒ `Types::AuthorizeClusterSecurityGroupIngressResult`

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

#build_request(operation_name, params = {}) ⇒ `Object`

#copy_cluster_snapshot(params = {}) ⇒ `Types::CopyClusterSnapshotResult`

#create_cluster(params = {}) ⇒ `Types::CreateClusterResult`

#create_cluster_parameter_group(params = {}) ⇒ `Types::CreateClusterParameterGroupResult`

#create_cluster_security_group(params = {}) ⇒ `Types::CreateClusterSecurityGroupResult`

#create_cluster_snapshot(params = {}) ⇒ `Types::CreateClusterSnapshotResult`

#create_cluster_subnet_group(params = {}) ⇒ `Types::CreateClusterSubnetGroupResult`

#create_event_subscription(params = {}) ⇒ `Types::CreateEventSubscriptionResult`

#create_hsm_client_certificate(params = {}) ⇒ `Types::CreateHsmClientCertificateResult`

#create_hsm_configuration(params = {}) ⇒ `Types::CreateHsmConfigurationResult`

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

#create_tags(params = {}) ⇒ `Struct`

#delete_cluster(params = {}) ⇒ `Types::DeleteClusterResult`

#delete_cluster_parameter_group(params = {}) ⇒ `Struct`

#delete_cluster_security_group(params = {}) ⇒ `Struct`

#delete_cluster_snapshot(params = {}) ⇒ `Types::DeleteClusterSnapshotResult`

#delete_cluster_subnet_group(params = {}) ⇒ `Struct`

#delete_event_subscription(params = {}) ⇒ `Struct`

#delete_hsm_client_certificate(params = {}) ⇒ `Struct`

#delete_hsm_configuration(params = {}) ⇒ `Struct`

#delete_snapshot_copy_grant(params = {}) ⇒ `Struct`

#delete_tags(params = {}) ⇒ `Struct`

#describe_cluster_parameter_groups(params = {}) ⇒ `Types::ClusterParameterGroupsMessage`

#describe_cluster_parameters(params = {}) ⇒ `Types::ClusterParameterGroupDetails`

#describe_cluster_security_groups(params = {}) ⇒ `Types::ClusterSecurityGroupMessage`

#describe_cluster_snapshots(params = {}) ⇒ `Types::SnapshotMessage`

#describe_cluster_subnet_groups(params = {}) ⇒ `Types::ClusterSubnetGroupMessage`

#describe_cluster_versions(params = {}) ⇒ `Types::ClusterVersionsMessage`

#describe_clusters(params = {}) ⇒ `Types::ClustersMessage`

#describe_default_cluster_parameters(params = {}) ⇒ `Types::DescribeDefaultClusterParametersResult`

#describe_event_categories(params = {}) ⇒ `Types::EventCategoriesMessage`

#describe_event_subscriptions(params = {}) ⇒ `Types::EventSubscriptionsMessage`

#describe_events(params = {}) ⇒ `Types::EventsMessage`

#describe_hsm_client_certificates(params = {}) ⇒ `Types::HsmClientCertificateMessage`

#describe_hsm_configurations(params = {}) ⇒ `Types::HsmConfigurationMessage`

#describe_logging_status(params = {}) ⇒ `Types::LoggingStatus`