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

Class: AWS::Redshift::Client

Inherits:
Core::QueryClient show all
Defined in:
lib/aws/redshift/client.rb

Overview

Client class for Amazon Redshift.

Direct Known Subclasses

V20121201

Defined Under Namespace

Classes: V20121201

Constant Summary

API_VERSION =
'2012-12-01'

Instance Attribute Summary

Attributes inherited from Core::Client

#config

Instance Method Summary collapse

Methods inherited from Core::Client

#initialize, #log_warning, #operations, #with_http_handler, #with_options

Constructor Details

This class inherits a constructor from AWS::Core::Client

Instance Method Details

#authorize_cluster_security_group_ingress(options = {}) ⇒ Core::Response

Calls the AuthorizeClusterSecurityGroupIngress API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_security_group_name - required - (String) The name of the security group to which the ingress rule is added.
    • :cidrip - (String) The IP range to be added the Amazon Redshift security group.
    • :ec2_security_group_name - (String) The EC2 security group to be added the Amazon Redshift security group.
    • :ec2_security_group_owner_id - (String) The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: 111122223333

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_security_group_name - (String)
    • :description - (String)
    • :ec_2_security_groups - (Array)
      • :status - (String)
      • :ec2_security_group_name - (String)
      • :ec2_security_group_owner_id - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
    • :ip_ranges - (Array)
      • :status - (String)
      • :cidrip - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#authorize_snapshot_access(options = {}) ⇒ Core::Response

Calls the AuthorizeSnapshotAccess API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_identifier - (String)
    • :cluster_identifier - (String)
    • :snapshot_create_time - (Time)
    • :status - (String)
    • :port - (Integer)
    • :availability_zone - (String)
    • :cluster_create_time - (Time)
    • :master_username - (String)
    • :cluster_version - (String)
    • :snapshot_type - (String)
    • :node_type - (String)
    • :number_of_nodes - (Integer)
    • :db_name - (String)
    • :vpc_id - (String)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)
    • :encrypted_with_hsm - (Boolean)
    • :accounts_with_restore_access - (Array)
      • :account_id - (String)
    • :owner_account - (String)
    • :total_backup_size_in_mega_bytes - (Numeric)
    • :actual_incremental_backup_size_in_mega_bytes - (Numeric)
    • :backup_progress_in_mega_bytes - (Numeric)
    • :current_backup_rate_in_mega_bytes_per_second - (Numeric)
    • :estimated_seconds_to_completion - (Integer)
    • :elapsed_time_in_seconds - (Integer)
    • :source_region - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#copy_cluster_snapshot(options = {}) ⇒ Core::Response

Calls the CopyClusterSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_identifier - (String)
    • :cluster_identifier - (String)
    • :snapshot_create_time - (Time)
    • :status - (String)
    • :port - (Integer)
    • :availability_zone - (String)
    • :cluster_create_time - (Time)
    • :master_username - (String)
    • :cluster_version - (String)
    • :snapshot_type - (String)
    • :node_type - (String)
    • :number_of_nodes - (Integer)
    • :db_name - (String)
    • :vpc_id - (String)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)
    • :encrypted_with_hsm - (Boolean)
    • :accounts_with_restore_access - (Array)
      • :account_id - (String)
    • :owner_account - (String)
    • :total_backup_size_in_mega_bytes - (Numeric)
    • :actual_incremental_backup_size_in_mega_bytes - (Numeric)
    • :backup_progress_in_mega_bytes - (Numeric)
    • :current_backup_rate_in_mega_bytes_per_second - (Numeric)
    • :estimated_seconds_to_completion - (Integer)
    • :elapsed_time_in_seconds - (Integer)
    • :source_region - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_cluster(options = {}) ⇒ Core::Response

Calls the CreateCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :db_name - (String) The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: dev Constraints: Must contain 1 to 64 alphanumeric characters. Must contain only lowercase letters. Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
    • :cluster_identifier - required - (String) A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: myexamplecluster
    • :cluster_type - (String) The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required. multi-node, the NumberOfNodes parameter is required. Valid Values: multi-node | single-node Default: multi-node
    • :node_type - required - (String) The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.8xlarge.
    • :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 in the Amazon Redshift Database Developer Guide.
    • :master_user_password - required - (String) The password associated with the master user account for the cluster that is being created. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
    • :cluster_security_groups - (Array<) 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<) 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.
    • :cluster_parameter_group_name - (String) The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints: Must be 1 to 255 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
    • :automated_snapshot_retention_period - (Integer) The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: 1 Constraints: Must be a value from 0 to 35.
    • :port - (Integer) The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: 5439 Valid Values: 1150-65535
    • :cluster_version - (String) The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster. Constraints: Only version 1.0 is currently available. Example: 1.0
    • :allow_version_upgrade - (Boolean) If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: true
    • :number_of_nodes - (Integer) The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: 1 Constraints: Value must be at least 1 and no more than 100.
    • :publicly_accessible - (Boolean) If true , the cluster can be accessed from a public network.
    • :encrypted - (Boolean) If true , the data in the cluster is encrypted at rest. Default: false
    • :hsm_client_certificate_identifier - (String) Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
    • :hsm_configuration_identifier - (String) Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
    • :elastic_ip - (String) The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
    • :tags - (Array<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.
    • :kms_key_id - (String) The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#create_cluster_parameter_group(options = {}) ⇒ Core::Response

Calls the CreateClusterParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :parameter_group_name - required - (String) The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric characters or hyphens First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique withing your AWS account. This value is stored as a lower-case string.
    • :parameter_group_family - required - (String) The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".
    • :description - required - (String) A description of the parameter group.
    • :tags - (Array<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :parameter_group_name - (String)
    • :parameter_group_family - (String)
    • :description - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_cluster_security_group(options = {}) ⇒ Core::Response

Calls the CreateClusterSecurityGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_security_group_name - (String)
    • :description - (String)
    • :ec_2_security_groups - (Array)
      • :status - (String)
      • :ec2_security_group_name - (String)
      • :ec2_security_group_owner_id - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
    • :ip_ranges - (Array)
      • :status - (String)
      • :cidrip - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_cluster_snapshot(options = {}) ⇒ Core::Response

Calls the CreateClusterSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_identifier - (String)
    • :cluster_identifier - (String)
    • :snapshot_create_time - (Time)
    • :status - (String)
    • :port - (Integer)
    • :availability_zone - (String)
    • :cluster_create_time - (Time)
    • :master_username - (String)
    • :cluster_version - (String)
    • :snapshot_type - (String)
    • :node_type - (String)
    • :number_of_nodes - (Integer)
    • :db_name - (String)
    • :vpc_id - (String)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)
    • :encrypted_with_hsm - (Boolean)
    • :accounts_with_restore_access - (Array)
      • :account_id - (String)
    • :owner_account - (String)
    • :total_backup_size_in_mega_bytes - (Numeric)
    • :actual_incremental_backup_size_in_mega_bytes - (Numeric)
    • :backup_progress_in_mega_bytes - (Numeric)
    • :current_backup_rate_in_mega_bytes_per_second - (Numeric)
    • :estimated_seconds_to_completion - (Integer)
    • :elapsed_time_in_seconds - (Integer)
    • :source_region - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_cluster_subnet_group(options = {}) ⇒ Core::Response

Calls the CreateClusterSubnetGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
    • :tags - (Array<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_subnet_group_name - (String)
    • :description - (String)
    • :vpc_id - (String)
    • :subnet_group_status - (String)
    • :subnets - (Array)
      • :subnet_identifier - (String)
      • :subnet_availability_zone - (Hash)
        • :name - (String)
      • :subnet_status - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_event_subscription(options = {}) ⇒ Core::Response

Calls the CreateEventSubscription API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) 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<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :customer_aws_id - (String)
    • :cust_subscription_id - (String)
    • :sns_topic_arn - (String)
    • :status - (String)
    • :subscription_creation_time - (Time)
    • :source_type - (String)
    • :source_ids_list - (Array)
    • :event_categories_list - (Array)
    • :severity - (String)
    • :enabled - (Boolean)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_hsm_client_certificate(options = {}) ⇒ Core::Response

Calls the CreateHsmClientCertificate API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :hsm_client_certificate_identifier - (String)
    • :hsm_client_certificate_public_key - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_hsm_configuration(options = {}) ⇒ Core::Response

Calls the CreateHsmConfiguration API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) A list of tag instances.
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :hsm_configuration_identifier - (String)
    • :description - (String)
    • :hsm_ip_address - (String)
    • :hsm_partition_name - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#create_tags(options = {}) ⇒ Core::Response

Calls the CreateTags API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter tag-key and the corresponding value is passed in with the parameter tag-value. The tag-key and tag-value parameters are separated by a colon (:). Separate multiple tags with a space. For example, --tags "tag-key"="owner":"tag-value"="admin" "tag-key"="environment":"tag-value"="test" "tag-key"="version":"tag-value"="1.0".
      • :key - (String) The key, or name, for the resource tag.
      • :value - (String) The value for the resource tag.

Returns:

#delete_cluster(options = {}) ⇒ Core::Response

Calls the DeleteCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The identifier of the cluster to be deleted. Constraints: Must contain lowercase characters. Must contain from 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.
    • :skip_final_cluster_snapshot - (Boolean) Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false . Default: false
    • :final_cluster_snapshot_identifier - (String) The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false . Constraints: Must be 1 to 255 alphanumeric characters. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#delete_cluster_parameter_group(options = {}) ⇒ Core::Response

Calls the DeleteClusterParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :parameter_group_name - required - (String) The name of the parameter group to be deleted. Constraints: Must be the name of an existing cluster parameter group. Cannot delete a default cluster parameter group.

Returns:

#delete_cluster_security_group(options = {}) ⇒ Core::Response

Calls the DeleteClusterSecurityGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_security_group_name - required - (String) The name of the cluster security group to be deleted.

Returns:

#delete_cluster_snapshot(options = {}) ⇒ Core::Response

Calls the DeleteClusterSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_identifier - (String)
    • :cluster_identifier - (String)
    • :snapshot_create_time - (Time)
    • :status - (String)
    • :port - (Integer)
    • :availability_zone - (String)
    • :cluster_create_time - (Time)
    • :master_username - (String)
    • :cluster_version - (String)
    • :snapshot_type - (String)
    • :node_type - (String)
    • :number_of_nodes - (Integer)
    • :db_name - (String)
    • :vpc_id - (String)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)
    • :encrypted_with_hsm - (Boolean)
    • :accounts_with_restore_access - (Array)
      • :account_id - (String)
    • :owner_account - (String)
    • :total_backup_size_in_mega_bytes - (Numeric)
    • :actual_incremental_backup_size_in_mega_bytes - (Numeric)
    • :backup_progress_in_mega_bytes - (Numeric)
    • :current_backup_rate_in_mega_bytes_per_second - (Numeric)
    • :estimated_seconds_to_completion - (Integer)
    • :elapsed_time_in_seconds - (Integer)
    • :source_region - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#delete_cluster_subnet_group(options = {}) ⇒ Core::Response

Calls the DeleteClusterSubnetGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_subnet_group_name - required - (String) The name of the cluster subnet group name to be deleted.

Returns:

#delete_event_subscription(options = {}) ⇒ Core::Response

Calls the DeleteEventSubscription API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :subscription_name - required - (String) The name of the Amazon Redshift event notification subscription to be deleted.

Returns:

#delete_hsm_client_certificate(options = {}) ⇒ Core::Response

Calls the DeleteHsmClientCertificate API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :hsm_client_certificate_identifier - required - (String) The identifier of the HSM client certificate to be deleted.

Returns:

#delete_hsm_configuration(options = {}) ⇒ Core::Response

Calls the DeleteHsmConfiguration API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :hsm_configuration_identifier - required - (String) The identifier of the Amazon Redshift HSM configuration to be deleted.

Returns:

#delete_tags(options = {}) ⇒ Core::Response

Calls the DeleteTags API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) The tag key that you want to delete.

Returns:

#describe_cluster_parameter_groups(options = {}) ⇒ Core::Response

Calls the DescribeClusterParameterGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_group_family - (String)
      • :description - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_cluster_parameters(options = {}) ⇒ Core::Response

Calls the DescribeClusterParameters API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :parameter_group_name - required - (String) The name of a cluster parameter group for which to return details.
    • :source - (String) The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :parameters - (Array)
      • :parameter_name - (String)
      • :parameter_value - (String)
      • :description - (String)
      • :source - (String)
      • :data_type - (String)
      • :allowed_values - (String)
      • :is_modifiable - (Boolean)
      • :minimum_engine_version - (String)
    • :marker - (String)

#describe_cluster_security_groups(options = {}) ⇒ Core::Response

Calls the DescribeClusterSecurityGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :description - (String)
      • :ec_2_security_groups - (Array)
        • :status - (String)
        • :ec2_security_group_name - (String)
        • :ec2_security_group_owner_id - (String)
        • :tags - (Array)
          • :key - (String)
          • :value - (String)
      • :ip_ranges - (Array)
        • :status - (String)
        • :cidrip - (String)
        • :tags - (Array)
          • :key - (String)
          • :value - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_cluster_snapshots(options = {}) ⇒ Core::Response

Calls the DescribeClusterSnapshots API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 - (String<) A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
    • :end_time - (String<) A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2012-07-16T18:00:00Z
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, 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<) 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<) 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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :snapshots - (Array)
      • :snapshot_identifier - (String)
      • :cluster_identifier - (String)
      • :snapshot_create_time - (Time)
      • :status - (String)
      • :port - (Integer)
      • :availability_zone - (String)
      • :cluster_create_time - (Time)
      • :master_username - (String)
      • :cluster_version - (String)
      • :snapshot_type - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :db_name - (String)
      • :vpc_id - (String)
      • :encrypted - (Boolean)
      • :kms_key_id - (String)
      • :encrypted_with_hsm - (Boolean)
      • :accounts_with_restore_access - (Array)
        • :account_id - (String)
      • :owner_account - (String)
      • :total_backup_size_in_mega_bytes - (Numeric)
      • :actual_incremental_backup_size_in_mega_bytes - (Numeric)
      • :backup_progress_in_mega_bytes - (Numeric)
      • :current_backup_rate_in_mega_bytes_per_second - (Numeric)
      • :estimated_seconds_to_completion - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :source_region - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_cluster_subnet_groups(options = {}) ⇒ Core::Response

Calls the DescribeClusterSubnetGroups API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cluster_subnet_groups - (Array)
      • :cluster_subnet_group_name - (String)
      • :description - (String)
      • :vpc_id - (String)
      • :subnet_group_status - (String)
      • :subnets - (Array)
        • :subnet_identifier - (String)
        • :subnet_availability_zone - (Hash)
          • :name - (String)
        • :subnet_status - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_cluster_versions(options = {}) ⇒ Core::Response

Calls the DescribeClusterVersions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_version - (String) The specific cluster version to return. Example: 1.0
    • :cluster_parameter_group_family - (String) The name of a specific cluster parameter group family to return details for. Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :cluster_versions - (Array)
      • :cluster_version - (String)
      • :cluster_parameter_group_family - (String)
      • :description - (String)

#describe_clusters(options = {}) ⇒ Core::Response

Calls the DescribeClusters API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :clusters - (Array)
      • :cluster_identifier - (String)
      • :node_type - (String)
      • :cluster_status - (String)
      • :modify_status - (String)
      • :master_username - (String)
      • :db_name - (String)
      • :endpoint - (Hash)
        • :address - (String)
        • :port - (Integer)
      • :cluster_create_time - (Time)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_security_groups - (Array)
        • :cluster_security_group_name - (String)
        • :status - (String)
      • :vpc_security_groups - (Array)
        • :vpc_security_group_id - (String)
        • :status - (String)
      • :cluster_parameter_groups - (Array)
        • :parameter_group_name - (String)
        • :parameter_apply_status - (String)
      • :cluster_subnet_group_name - (String)
      • :vpc_id - (String)
      • :availability_zone - (String)
      • :preferred_maintenance_window - (String)
      • :pending_modified_values - (Hash)
        • :master_user_password - (String)
        • :node_type - (String)
        • :number_of_nodes - (Integer)
        • :cluster_type - (String)
        • :cluster_version - (String)
        • :automated_snapshot_retention_period - (Integer)
        • :cluster_identifier - (String)
      • :cluster_version - (String)
      • :allow_version_upgrade - (Boolean)
      • :number_of_nodes - (Integer)
      • :publicly_accessible - (Boolean)
      • :encrypted - (Boolean)
      • :restore_status - (Hash)
        • :status - (String)
        • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
        • :snapshot_size_in_mega_bytes - (Integer)
        • :progress_in_mega_bytes - (Integer)
        • :elapsed_time_in_seconds - (Integer)
        • :estimated_time_to_completion_in_seconds - (Integer)
      • :hsm_status - (Hash)
        • :hsm_client_certificate_identifier - (String)
        • :hsm_configuration_identifier - (String)
        • :status - (String)
      • :cluster_snapshot_copy_status - (Hash)
        • :destination_region - (String)
        • :retention_period - (Integer)
      • :cluster_public_key - (String)
      • :cluster_nodes - (Array)
        • :node_role - (String)
        • :private_ip_address - (String)
        • :public_ip_address - (String)
      • :elastic_ip_status - (Hash)
        • :elastic_ip - (String)
        • :status - (String)
      • :cluster_revision_number - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
      • :kms_key_id - (String)

#describe_default_cluster_parameters(options = {}) ⇒ Core::Response

Calls the DescribeDefaultClusterParameters API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :parameter_group_family - required - (String) The name of the cluster parameter group family.
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :parameter_group_family - (String)
    • :marker - (String)
    • :parameters - (Array)
      • :parameter_name - (String)
      • :parameter_value - (String)
      • :description - (String)
      • :source - (String)
      • :data_type - (String)
      • :allowed_values - (String)
      • :is_modifiable - (Boolean)
      • :minimum_engine_version - (String)

#describe_event_categories(options = {}) ⇒ Core::Response

Calls the DescribeEventCategories API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :source_type - (String) The source type, such as cluster or parameter group, to which the described event categories apply. Valid values: cluster, snapshot, parameter group, and security group.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :event_categories_map_list - (Array)
      • :source_type - (String)
      • :events - (Array)
        • :event_id - (String)
        • :event_categories - (Array)
        • :event_description - (String)
        • :severity - (String)

#describe_event_subscriptions(options = {}) ⇒ Core::Response

Calls the DescribeEventSubscriptions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :event_subscriptions_list - (Array)
      • :customer_aws_id - (String)
      • :cust_subscription_id - (String)
      • :sns_topic_arn - (String)
      • :status - (String)
      • :subscription_creation_time - (Time)
      • :source_type - (String)
      • :source_ids_list - (Array)
      • :event_categories_list - (Array)
      • :severity - (String)
      • :enabled - (Boolean)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_events(options = {}) ⇒ Core::Response

Calls the DescribeEvents API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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. Valid values include:
      • cluster
      • cluster-parameter-group
      • cluster-security-group
      • cluster-snapshot
    • :start_time - (String<) The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
    • :end_time - (String<) The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. Example: 2009-07-08T18:00Z
    • :duration - (Integer) The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. Default: 60
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :events - (Array)
      • :source_identifier - (String)
      • :source_type - (String)
      • :message - (String)
      • :event_categories - (Array)
      • :severity - (String)
      • :date - (Time)
      • :event_id - (String)

#describe_hsm_client_certificates(options = {}) ⇒ Core::Response

Calls the DescribeHsmClientCertificates API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :hsm_client_certificates - (Array)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_client_certificate_public_key - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_hsm_configurations(options = {}) ⇒ Core::Response

Calls the DescribeHsmConfigurations API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :hsm_configurations - (Array)
      • :hsm_configuration_identifier - (String)
      • :description - (String)
      • :hsm_ip_address - (String)
      • :hsm_partition_name - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)

#describe_logging_status(options = {}) ⇒ Core::Response

Calls the DescribeLoggingStatus API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The identifier of the cluster to get the logging status from. Example: examplecluster

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :logging_enabled - (Boolean)
    • :bucket_name - (String)
    • :s3_key_prefix - (String)
    • :last_successful_delivery_time - (Time)
    • :last_failure_time - (Time)
    • :last_failure_message - (String)

#describe_orderable_cluster_options(options = {}) ⇒ Core::Response

Calls the DescribeOrderableClusterOptions API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_version - (String) The version filter value. Specify this parameter to show only the available offerings matching the specified version. Default: All versions. Constraints: Must be one of the version returned from DescribeClusterVersions.
    • :node_type - (String) The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :orderable_cluster_options - (Array)
      • :cluster_version - (String)
      • :cluster_type - (String)
      • :node_type - (String)
      • :availability_zones - (Array)
        • :name - (String)
    • :marker - (String)

#describe_reserved_node_offerings(options = {}) ⇒ Core::Response

Calls the DescribeReservedNodeOfferings API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :reserved_node_offering_id - (String) The unique identifier for the offering.
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :reserved_node_offerings - (Array)
      • :reserved_node_offering_id - (String)
      • :node_type - (String)
      • :duration - (Integer)
      • :fixed_price - (Numeric)
      • :usage_price - (Numeric)
      • :currency_code - (String)
      • :offering_type - (String)
      • :recurring_charges - (Array)
        • :recurring_charge_amount - (Numeric)
        • :recurring_charge_frequency - (String)

#describe_reserved_nodes(options = {}) ⇒ Core::Response

Calls the DescribeReservedNodes API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :reserved_node_id - (String) Identifier for the node reservation.
    • :max_records - (Integer) The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
    • :marker - (String) An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :marker - (String)
    • :reserved_nodes - (Array)
      • :reserved_node_id - (String)
      • :reserved_node_offering_id - (String)
      • :node_type - (String)
      • :start_time - (Time)
      • :duration - (Integer)
      • :fixed_price - (Numeric)
      • :usage_price - (Numeric)
      • :currency_code - (String)
      • :node_count - (Integer)
      • :state - (String)
      • :offering_type - (String)
      • :recurring_charges - (Array)
        • :recurring_charge_amount - (Numeric)
        • :recurring_charge_frequency - (String)

#describe_resize(options = {}) ⇒ Core::Response

Calls the DescribeResize API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive. By default, resize operations for all clusters defined for an AWS account are returned.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :target_node_type - (String)
    • :target_number_of_nodes - (Integer)
    • :target_cluster_type - (String)
    • :status - (String)
    • :import_tables_completed - (Array)
    • :import_tables_in_progress - (Array)
    • :import_tables_not_started - (Array)
    • :avg_resize_rate_in_mega_bytes_per_second - (Numeric)
    • :total_resize_data_in_mega_bytes - (Integer)
    • :progress_in_mega_bytes - (Integer)
    • :elapsed_time_in_seconds - (Integer)
    • :estimated_time_to_completion_in_seconds - (Integer)

#describe_tags(options = {}) ⇒ Core::Response

Calls the DescribeTags API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 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.
    • :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<) 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<) A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :tagged_resources - (Array)
      • :tag - (Hash)
        • :key - (String)
        • :value - (String)
      • :resource_name - (String)
      • :resource_type - (String)
    • :marker - (String)

#disable_logging(options = {}) ⇒ Core::Response

Calls the DisableLogging API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The identifier of the cluster on which logging is to be stopped. Example: examplecluster

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :logging_enabled - (Boolean)
    • :bucket_name - (String)
    • :s3_key_prefix - (String)
    • :last_successful_delivery_time - (Time)
    • :last_failure_time - (Time)
    • :last_failure_message - (String)

#disable_snapshot_copy(options = {}) ⇒ Core::Response

Calls the DisableSnapshotCopy API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region. Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#enable_logging(options = {}) ⇒ Core::Response

Calls the EnableLogging API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The identifier of the cluster on which logging is to be started. Example: examplecluster
    • :bucket_name - required - (String) The name of an existing S3 bucket where the log files are to be stored. Constraints: Must be in the same region as the cluster The cluster must have read bucket and put object permissions
    • :s3_key_prefix - (String) The prefix applied to the log file names. Constraints: Cannot exceed 512 characters Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (), or control characters. The hexadecimal codes for invalid characters are: x00 to x20 x22 x27 x5c x7f or larger

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :logging_enabled - (Boolean)
    • :bucket_name - (String)
    • :s3_key_prefix - (String)
    • :last_successful_delivery_time - (Time)
    • :last_failure_time - (Time)
    • :last_failure_message - (String)

#enable_snapshot_copy(options = {}) ⇒ Core::Response

Calls the EnableSnapshotCopy API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#modify_cluster(options = {}) ⇒ Core::Response

Calls the ModifyCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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: dw1.xlarge | dw1.8xlarge | dw2.large | dw2.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<) 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<) 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. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost. Default: Uses existing setting. Constraints: Must be between 8 and 64 characters in length. Must contain at least one uppercase letter. Must contain at least one lowercase letter. Must contain one number. Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
    • :cluster_parameter_group_name - (String) The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster. Default: Uses existing setting. Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
    • :automated_snapshot_retention_period - (Integer) The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted. Default: Uses existing setting. Constraints: Must be a value from 0 to 35.
    • :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 managing parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide. Example: 1.0
    • :allow_version_upgrade - (Boolean) If true , major version upgrades will be applied automatically to the cluster during the maintenance window. Default: false
    • :hsm_client_certificate_identifier - (String) Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
    • :hsm_configuration_identifier - (String) Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
    • :new_cluster_identifier - (String) The new identifier for the cluster. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens. Alphabetic characters must be lowercase. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Must be unique for all clusters within an AWS account. Example: examplecluster

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#modify_cluster_parameter_group(options = {}) ⇒ Core::Response

Calls the ModifyClusterParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :parameter_group_name - required - (String) The name of the parameter group to be modified.
    • :parameters - required - (Array<) 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.
      • :parameter_name - (String) The name of the parameter.
      • :parameter_value - (String) The value of the parameter.
      • :description - (String) A description of the parameter.
      • :source - (String) The source of the parameter value, such as "engine-default" or "user".
      • :data_type - (String) The data type of the parameter.
      • :allowed_values - (String) The valid range of values for the parameter.
      • :is_modifiable - (Boolean) If true , the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
      • :minimum_engine_version - (String) The earliest engine version to which the parameter can apply.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :parameter_group_name - (String)
    • :parameter_group_status - (String)

#modify_cluster_subnet_group(options = {}) ⇒ Core::Response

Calls the ModifyClusterSubnetGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_subnet_group_name - (String)
    • :description - (String)
    • :vpc_id - (String)
    • :subnet_group_status - (String)
    • :subnets - (Array)
      • :subnet_identifier - (String)
      • :subnet_availability_zone - (Hash)
        • :name - (String)
      • :subnet_status - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#modify_event_subscription(options = {}) ⇒ Core::Response

Calls the ModifyEventSubscription API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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<) Specifies the Amazon Redshift event categories to be published by the event notification subscription. Values: Configuration, Management, Monitoring, Security
    • :severity - (String) Specifies the Amazon Redshift event severity to be published by the event notification subscription. Values: ERROR, INFO
    • :enabled - (Boolean) A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :customer_aws_id - (String)
    • :cust_subscription_id - (String)
    • :sns_topic_arn - (String)
    • :status - (String)
    • :subscription_creation_time - (Time)
    • :source_type - (String)
    • :source_ids_list - (Array)
    • :event_categories_list - (Array)
    • :severity - (String)
    • :enabled - (Boolean)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#modify_snapshot_copy_retention_period(options = {}) ⇒ Core::Response

Calls the ModifySnapshotCopyRetentionPeriod API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#purchase_reserved_node_offering(options = {}) ⇒ Core::Response

Calls the PurchaseReservedNodeOffering API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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 you want to purchase. Default: 1

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :reserved_node_id - (String)
    • :reserved_node_offering_id - (String)
    • :node_type - (String)
    • :start_time - (Time)
    • :duration - (Integer)
    • :fixed_price - (Numeric)
    • :usage_price - (Numeric)
    • :currency_code - (String)
    • :node_count - (Integer)
    • :state - (String)
    • :offering_type - (String)
    • :recurring_charges - (Array)
      • :recurring_charge_amount - (Numeric)
      • :recurring_charge_frequency - (String)

#reboot_cluster(options = {}) ⇒ Core::Response

Calls the RebootCluster API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The cluster identifier.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#reset_cluster_parameter_group(options = {}) ⇒ Core::Response

Calls the ResetClusterParameterGroup API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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<) 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.
      • :parameter_name - (String) The name of the parameter.
      • :parameter_value - (String) The value of the parameter.
      • :description - (String) A description of the parameter.
      • :source - (String) The source of the parameter value, such as "engine-default" or "user".
      • :data_type - (String) The data type of the parameter.
      • :allowed_values - (String) The valid range of values for the parameter.
      • :is_modifiable - (Boolean) If true , the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
      • :minimum_engine_version - (String) The earliest engine version to which the parameter can apply.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :parameter_group_name - (String)
    • :parameter_group_status - (String)

#restore_from_cluster_snapshot(options = {}) ⇒ Core::Response

Calls the RestoreFromClusterSnapshot API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :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.
    • :cluster_security_groups - (Array<) 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<) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Default: The default VPC security group is associated with the cluster. VPC security groups only apply to clusters in VPCs.
    • :preferred_maintenance_window - (String) The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window.
    • :automated_snapshot_retention_period - (Integer) The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. Default: The value selected for the cluster from which the snapshot was taken. Constraints: Must be a value from 0 to 35.
    • :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.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)

#revoke_cluster_security_group_ingress(options = {}) ⇒ Core::Response

Calls the RevokeClusterSecurityGroupIngress API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_security_group_name - required - (String) The name of the security Group from which to revoke the ingress rule.
    • :cidrip - (String) The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.
    • :ec2_security_group_name - (String) The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.
    • :ec2_security_group_owner_id - (String) The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided. Example: 111122223333

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_security_group_name - (String)
    • :description - (String)
    • :ec_2_security_groups - (Array)
      • :status - (String)
      • :ec2_security_group_name - (String)
      • :ec2_security_group_owner_id - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
    • :ip_ranges - (Array)
      • :status - (String)
      • :cidrip - (String)
      • :tags - (Array)
        • :key - (String)
        • :value - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#revoke_snapshot_access(options = {}) ⇒ Core::Response

Calls the RevokeSnapshotAccess API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :snapshot_identifier - required - (String) The identifier of the snapshot that the account can no longer access.
    • :snapshot_cluster_identifier - (String) The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
    • :account_with_restore_access - required - (String) The identifier of the AWS customer account that can no longer restore the specified snapshot.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :snapshot_identifier - (String)
    • :cluster_identifier - (String)
    • :snapshot_create_time - (Time)
    • :status - (String)
    • :port - (Integer)
    • :availability_zone - (String)
    • :cluster_create_time - (Time)
    • :master_username - (String)
    • :cluster_version - (String)
    • :snapshot_type - (String)
    • :node_type - (String)
    • :number_of_nodes - (Integer)
    • :db_name - (String)
    • :vpc_id - (String)
    • :encrypted - (Boolean)
    • :kms_key_id - (String)
    • :encrypted_with_hsm - (Boolean)
    • :accounts_with_restore_access - (Array)
      • :account_id - (String)
    • :owner_account - (String)
    • :total_backup_size_in_mega_bytes - (Numeric)
    • :actual_incremental_backup_size_in_mega_bytes - (Numeric)
    • :backup_progress_in_mega_bytes - (Numeric)
    • :current_backup_rate_in_mega_bytes_per_second - (Numeric)
    • :estimated_seconds_to_completion - (Integer)
    • :elapsed_time_in_seconds - (Integer)
    • :source_region - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)

#rotate_encryption_key(options = {}) ⇒ Core::Response

Calls the RotateEncryptionKey API operation.

Parameters:

  • options (Hash) (defaults to: {})
    • :cluster_identifier - required - (String) The unique identifier of the cluster that you want to rotate the encryption keys for. Constraints: Must be the name of valid cluster that has encryption enabled.

Returns:

  • (Core::Response)

    The #data method of the response object returns a hash with the following structure:

    • :cluster_identifier - (String)
    • :node_type - (String)
    • :cluster_status - (String)
    • :modify_status - (String)
    • :master_username - (String)
    • :db_name - (String)
    • :endpoint - (Hash)
      • :address - (String)
      • :port - (Integer)
    • :cluster_create_time - (Time)
    • :automated_snapshot_retention_period - (Integer)
    • :cluster_security_groups - (Array)
      • :cluster_security_group_name - (String)
      • :status - (String)
    • :vpc_security_groups - (Array)
      • :vpc_security_group_id - (String)
      • :status - (String)
    • :cluster_parameter_groups - (Array)
      • :parameter_group_name - (String)
      • :parameter_apply_status - (String)
    • :cluster_subnet_group_name - (String)
    • :vpc_id - (String)
    • :availability_zone - (String)
    • :preferred_maintenance_window - (String)
    • :pending_modified_values - (Hash)
      • :master_user_password - (String)
      • :node_type - (String)
      • :number_of_nodes - (Integer)
      • :cluster_type - (String)
      • :cluster_version - (String)
      • :automated_snapshot_retention_period - (Integer)
      • :cluster_identifier - (String)
    • :cluster_version - (String)
    • :allow_version_upgrade - (Boolean)
    • :number_of_nodes - (Integer)
    • :publicly_accessible - (Boolean)
    • :encrypted - (Boolean)
    • :restore_status - (Hash)
      • :status - (String)
      • :current_restore_rate_in_mega_bytes_per_second - (Numeric)
      • :snapshot_size_in_mega_bytes - (Integer)
      • :progress_in_mega_bytes - (Integer)
      • :elapsed_time_in_seconds - (Integer)
      • :estimated_time_to_completion_in_seconds - (Integer)
    • :hsm_status - (Hash)
      • :hsm_client_certificate_identifier - (String)
      • :hsm_configuration_identifier - (String)
      • :status - (String)
    • :cluster_snapshot_copy_status - (Hash)
      • :destination_region - (String)
      • :retention_period - (Integer)
    • :cluster_public_key - (String)
    • :cluster_nodes - (Array)
      • :node_role - (String)
      • :private_ip_address - (String)
      • :public_ip_address - (String)
    • :elastic_ip_status - (Hash)
      • :elastic_ip - (String)
      • :status - (String)
    • :cluster_revision_number - (String)
    • :tags - (Array)
      • :key - (String)
      • :value - (String)
    • :kms_key_id - (String)