Class Fog::AWS::Redshift::Real
In: lib/fog/aws/redshift.rb
lib/fog/aws/requests/redshift/modify_cluster_parameter_group.rb
lib/fog/aws/requests/redshift/describe_default_cluster_parameters.rb
lib/fog/aws/requests/redshift/delete_cluster_subnet_group.rb
lib/fog/aws/requests/redshift/modify_cluster_subnet_group.rb
lib/fog/aws/requests/redshift/reboot_cluster.rb
lib/fog/aws/requests/redshift/authorize_cluster_security_group_ingress.rb
lib/fog/aws/requests/redshift/authorize_snapshot_access.rb
lib/fog/aws/requests/redshift/describe_reserved_nodes.rb
lib/fog/aws/requests/redshift/describe_orderable_cluster_options.rb
lib/fog/aws/requests/redshift/describe_cluster_security_groups.rb
lib/fog/aws/requests/redshift/copy_cluster_snapshot.rb
lib/fog/aws/requests/redshift/restore_from_cluster_snapshot.rb
lib/fog/aws/requests/redshift/modify_cluster.rb
lib/fog/aws/requests/redshift/describe_cluster_versions.rb
lib/fog/aws/requests/redshift/delete_cluster_snapshot.rb
lib/fog/aws/requests/redshift/describe_cluster_parameter_groups.rb
lib/fog/aws/requests/redshift/describe_events.rb
lib/fog/aws/requests/redshift/describe_clusters.rb
lib/fog/aws/requests/redshift/describe_resize.rb
lib/fog/aws/requests/redshift/create_cluster_snapshot.rb
lib/fog/aws/requests/redshift/create_cluster_parameter_group.rb
lib/fog/aws/requests/redshift/purchase_reserved_node_offering.rb
lib/fog/aws/requests/redshift/delete_cluster_parameter_group.rb
lib/fog/aws/requests/redshift/create_cluster_security_group.rb
lib/fog/aws/requests/redshift/describe_cluster_snapshots.rb
lib/fog/aws/requests/redshift/describe_cluster_subnet_groups.rb
lib/fog/aws/requests/redshift/reset_cluster_parameter_group.rb
lib/fog/aws/requests/redshift/create_cluster.rb
lib/fog/aws/requests/redshift/delete_cluster.rb
lib/fog/aws/requests/redshift/describe_cluster_parameters.rb
lib/fog/aws/requests/redshift/revoke_snapshot_access.rb
lib/fog/aws/requests/redshift/revoke_cluster_security_group_ingress.rb
lib/fog/aws/requests/redshift/delete_cluster_security_group.rb
lib/fog/aws/requests/redshift/describe_reserved_node_offerings.rb
lib/fog/aws/requests/redshift/create_cluster_subnet_group.rb
Parent: Object

Methods

Included Modules

Fog::AWS::CredentialFetcher::ConnectionMethods

Public Class methods

Initialize connection to Redshift

Notes

options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection

Examples

  ses = SES.new(
   :aws_access_key_id => your_aws_access_key_id,
   :aws_secret_access_key => your_aws_secret_access_key
  )

Parameters

  • options<~Hash> - config arguments for connection. Defaults to {}.
    • region<~String> - optional region to use. For instance, ‘us-east-1’ and etc.

Returns

Public Instance methods

Parameters

@param [Hash] options

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

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_AuthorizeClusterSecurityGroupIngress.html

Parameters

@param [Hash] options

  • :snapshot_identifier - required - (String)
     The identifier of the snapshot the account is authorized to restore.
    
  • :snapshot_cluster_identifier - (String)
  • :account_with_restore_access - required - (String)
     The identifier of the AWS customer account authorized to restore the specified snapshot.       #
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CopyClusterSnapshot.html

Parameters

@param [Hash] options

  • :source_snapshot_identifier - required - (String)
     The identifier for the source snapshot. Constraints: Must be the identifier for
     a valid automated snapshot whose state is "available".
    
  • :source_snapshot_cluster_identifier - (String)
  • :target_snapshot_identifier - required - (String)
     The identifier given to the new manual snapshot. Constraints: Cannot be null,
     empty, or blank. Must contain from 1 to 255 alphanumeric characters or hyphens.
     First character must be a letter. Cannot end with a hyphen or contain two
     consecutive hyphens. Must be unique for the AWS account that is making the request.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CopyClusterSnapshot.html

Parameters

@param [Hash] options

  • :parameter_group_name - required - (String)
     The name of the cluster parameter group. Constraints: Must be 1 to 255 alphanumeric
     characters or hyphens First character must be a letter. Cannot end with a hyphen or
     contain two consecutive hyphens. Must be unique within 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.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterParameterGroup.html

Parameters

@param [Hash] options

  • :cluster_security_group_name - (String)
     The name of a cluster security group for which you are requesting details. You
     can specify either the Marker parameter or a ClusterSecurityGroupName parameter,
     but not both. Example: securitygroup1
    
  • :description - required - (String)
     A description for the security group.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSecurityGroup.html

Parameters

@param [Hash] options

  • :snapshot_identifier - required - (String)
     A unique identifier for the snapshot that you are requesting. This identifier
     must be unique for all snapshots within the AWS account. Constraints: Cannot be
     null, empty, or blank Must contain from 1 to 255 alphanumeric characters or
     hyphens First character must be a letter Cannot end with a hyphen or contain two
     consecutive hyphens Example: my-snapshot-id
    
  • :cluster_identifier - required - (String)
     The cluster identifier for which you want a snapshot.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSnapshot.html

Parameters

@param [Hash] options

  • :cluster_subnet_group_name - required - (String)
     The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
     Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not
     be "Default". Must be unique for all subnet groups that are created by your AWS account.
     Example: examplesubnetgroup
    
  • :description - required - (String)
     A description of the parameter group.
    
  • :subnet_ids - required - (Array<)
     An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSubnetGroup.html

Parameters

@param [Hash] options

  • :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. Must be unique
     for all clusters within an AWS account. Example: myexamplecluster
    
  • :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.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DeleteCluster.html

Parameters

@param [Hash] options

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

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DeleteClusterParameterGroup.html

Parameters

@param [Hash] options

  • :cluster_security_group_name - required - (String)
     The name of the cluster security group to be deleted.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DeleteClusterSecurityGroup.html

Parameters

@param [Hash] options

  • :snapshot_identifier - required - (String)
     A unique identifier for the snapshot that you are requesting. This identifier
     must be unique for all snapshots within the AWS account. Constraints: Cannot be
     null, empty, or blank Must contain from 1 to 255 alphanumeric characters or
     hyphens First character must be a letter Cannot end with a hyphen or contain two
     consecutive hyphens Example: my-snapshot-id
    
  • :snapshot_cluster_identifier - required - (String)
     The cluster identifier for which you want a snapshot.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CreateClusterSnapshot.html

Parameters

@param [Hash] options

  • :cluster_subnet_group_name - required - (String)
     The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
     Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not
     be "Default". Must be unique for all subnet groups that are created by your AWS account.
     Example: examplesubnetgroup
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DeleteClusterSubnetGroup.html

Parameters

@param [Hash] options

  • :parameter_group_name (String)
     The name of a cluster parameter group for which to return details.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterParameterGroups.html

Parameters

@param [Hash] options

  • :parameter_group_name - required - (String)
     The name of a cluster parameter group for which to return details.
    
  • :source - (String)
     The parameter types to return. Specify user to show parameters that are
     different form the default. Similarly, specify engine-default to show parameters
     that are the same as the default parameter group. Default: All parameter types
     returned. Valid Values: user | engine-default
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterParameters.html

Parameters

@param [Hash] options

  • :cluster_security_group_name - (String)
     The name of a cluster security group for which you are requesting details. You
     can specify either the Marker parameter or a ClusterSecurityGroupName parameter,
     but not both. Example: securitygroup1
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterSecurityGroups.html

Parameters

@param [Hash] options

  • :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
    
  • :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.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterSnapshots.html

Parameters

@param [Hash] options

  • :cluster_subnet_group_name - (String)
     The name of the cluster subnet group for which information is requested.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterSubnetGroups.html

Parameters

@param [Hash] options

  • :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, and cannot end with a hyphen or contain two consecutive hyphens.
    
  • :cluster_version - (String)
     The specific cluster version to return. Example: 1.0
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterVersions.html

Parameters

@param [Hash] options

  • :cluster_identifier - (String)
     The unique identifier of a cluster whose properties you are requesting.
     This parameter isn't case sensitive. The default is that all clusters
     defined for an account are returned.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusters.html

Parameters

@param [Hash] options

  • :parameter_group_family - required - (String)
     The name of a cluster parameter group family for which to return details.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeDefaultClusterParameters.html

Parameters

@param [Hash] options

  • :source_identifier - (String)
     The identifier of the event source for which events will be returned. If this
     parameter is not specified, then all sources are included in the response.
     Constraints: If SourceIdentifier is supplied, SourceType must also be provided.
     Specify a cluster identifier when SourceType is cluster. Specify a cluster security
     group name when SourceType is cluster-security-group. Specify a cluster parameter
     group name when SourceType is cluster-parameter-group. Specify a cluster snapshot
     identifier when SourceType is cluster-snapshot.
    
  • :source_type - (String)
     The event source to retrieve events for. If no value is specified, all events are
     returned. Constraints: If SourceType is supplied, SourceIdentifier must also be
     provided. Specify cluster when SourceIdentifier is a cluster identifier. Specify
     cluster-security-group when SourceIdentifier is a cluster security group name. Specify
     cluster-parameter-group when SourceIdentifier is a cluster parameter group name. Specify
     cluster-snapshot when SourceIdentifier is a cluster snapshot identifier. 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. Example: 2009-07-08T18:00Z
    
  • :end_time - (String<)
     The end of the time interval for which to retrieve events, specified in ISO 8601
     format. 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 records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeEvents.html

Parameters

@param [Hash] options

  • :cluster_version - (String)
     The version filter value. Specify this parameter to show only the available
     offerings matching the specified version. Default: All versions. Constraints:
     Must be one of the version returned from DescribeClusterVersions.
    
  • :node_type - (String)
     The node type filter value. Specify this parameter to show only the available
     offerings matching the specified node type.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeOrderableClusterOptions.html

Parameters

@param [Hash] options

  • :reserved_node_offering_id - (String)
     The unique identifier for the offering.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeReservedNodeOfferings.html

Parameters

@param [Hash] options

  • :reserved_node_id - (String)
     The unique identifier for the node reservation.
    
  • :max_records - (Integer)
     The maximum number of records to include in the response. If more than the
     MaxRecords value is available, a marker is included in the response so that the
     following results can be retrieved. Constrained between [20,100]. Default is 100.
    
  • :marker - (String)
     The marker returned from a previous request. If this parameter is specified, the
     response includes records beyond the marker only, up to MaxRecords.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeReservedNodes.html

Parameters

@param [Hash] options

  • :cluster_identifier - required - (String)
     The unique identifier of a cluster whose resize progress you are requesting.
     This parameter isn't case-sensitive. By default, resize operations for all
     clusters defined for an AWS account are returned.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeResize.html

Parameters

@param [Hash] options

  • :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. Must be unique
     for all clusters within an AWS account. Example: myexamplecluster
    
  • :allow_version_upgrade - (Boolean)
     If `true` , upgrades can be applied during the maintenance window to the Amazon
     Redshift engine that is running on the cluster. Default:  `true`
    
  • :automated_snapshot_retention_period - (Integer)
     Number of days that automated snapshots are retained. If the value is 0, automated
     snapshots are disabled.  Default: 1 Constraints: Must be a value from 0 to 35.
    
  • :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. Constraints: Must be 1 to 255
     alphanumeric characters or hyphens. First character must be a letter. Cannot end
     with a hyphen or contain two consecutive hyphens.
    
  • :cluster_security_groups - (Array<String>)
     A list of security groups to be associated with this cluster. Default: The default
     cluster security group for Amazon Redshift.
    
  • :cluster_type - (String)
     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
    
  • :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
    
  • :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.
    
  • :node_type - required - (String)
     The node type to be provisioned. Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.
    
  • :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. 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.
    
  • :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.
     Constraints: Minimum 30-minute window.
    
  • :vpc_security_group_ids - (Array<String>)
     A list of Virtual Private Cloud (VPC) security groups to be associated with the
     cluster. Default: The default VPC security group is associated with the cluster.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_CreateCluster.html

Parameters

@param [Hash] options

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

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_ModifyClusterParameterGroup.html

Parameters

@param [Hash] options

  • :cluster_subnet_group_name - required - (String)
     The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
     Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not
     be "Default". Must be unique for all subnet groups that are created by your AWS account.
     Example: examplesubnetgroup
    
  • :description - required - (String)
     A description of the parameter group.
    
  • :subnet_ids - required - (Array<)
     An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_ModifyClusterSubnetGroup.html

Parameters

@param [Hash] options

  • :reserved_node_offering_id - required - (String)
     The unique identifier of the reserved node offering you want to purchase.
    
  • :node_count - (Integer)
     The number of reserved nodes you want to purchase. Default: 1
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_PurchaseReservedNodeOffering.html

Parameters

@param [Hash] options

  • :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. Must be unique
     for all clusters within an AWS account. Example: myexamplecluster
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_DeleteCluster.html

Parameters

@param [Hash] options

  • :parameter_group_name - required - (String) The name of the cluster parameter group to be reset.
  • :reset_all_parameters - (Boolean) If true , all parameters in the specified parameter group will be reset to their default values. Default: true
  • :parameters - (Array<) 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.

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_ResetClusterParameterGroup.html

Parameters

@param [Hash] options

  • :cluster_identifier - required - (String)
     The identifier of the cluster that will be created from restoring the snapshot.
     Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens.
     Alphabetic characters must be lowercase. First character must be a letter. Cannot
     end with a hyphen or contain two consecutive hyphens. Must be unique for all
     clusters within an AWS account.
    
  • :snapshot_identifier - required - (String)
     The name of the snapshot from which to create the new cluster. This parameter
     isn't case sensitive. Example: my-snapshot-id
    
  • :snapshot_cluster_identifier - (String)
  • :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 , 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.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_RestoreFromClusterSnapshot.html

Parameters

@param [Hash] options

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

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_RevokeClusterSecurityGroupIngress.html

Parameters

@param [Hash] options

  • :snapshot_identifier - required - (String)
     The identifier of the snapshot that the account can no longer access.
    
  • :snapshot_cluster_identifier - (String)
  • :account_with_restore_access - required - (String)
     The identifier of the AWS customer account that can no longer restore the specified snapshot.
    

See Also

docs.aws.amazon.com/redshift/latest/APIReference/API_RevokeSnapshotAccess.html

[Validate]