GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::RedShift(3) User Contributed Perl Documentation Paws::RedShift(3)

Paws::RedShift - Perl Interface to AWS Amazon Redshift

  use Paws;
  my $obj = Paws->service('RedShift');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

Amazon Redshift

Overview

This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces (https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html).

Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide (https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html).

If you are a database developer, the Amazon Redshift Database Developer Guide (https://docs.aws.amazon.com/redshift/latest/dg/welcome.html) explains how to design, build, query, and maintain the databases that make up your data warehouse.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01>

Each argument is described in detail in: Paws::RedShift::AcceptReservedNodeExchange

Returns: a Paws::RedShift::AcceptReservedNodeExchangeOutputMessage instance

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

Each argument is described in detail in: Paws::RedShift::AddPartner

Returns: a Paws::RedShift::PartnerIntegrationOutputMessage instance

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

[CIDRIP => Str]
[EC2SecurityGroupName => Str]
[EC2SecurityGroupOwnerId => Str]

Each argument is described in detail in: Paws::RedShift::AuthorizeClusterSecurityGroupIngress

Returns: a Paws::RedShift::AuthorizeClusterSecurityGroupIngressResult instance

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.

If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing (http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the Amazon Redshift Cluster Management Guide.

[ClusterIdentifier => Str]
[VpcIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::AuthorizeEndpointAccess

Returns: a Paws::RedShift::EndpointAuthorization instance

Grants access to a cluster.

[SnapshotClusterIdentifier => Str]

Each argument is described in detail in: Paws::RedShift::AuthorizeSnapshotAccess

Returns: a Paws::RedShift::AuthorizeSnapshotAccessResult instance

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

For more information about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the Amazon Redshift Cluster Management Guide.

Each argument is described in detail in: Paws::RedShift::BatchDeleteClusterSnapshots

Returns: a Paws::RedShift::BatchDeleteClusterSnapshotsResult instance

Deletes a set of cluster snapshots.

[Force => Bool]
[ManualSnapshotRetentionPeriod => Int]

Each argument is described in detail in: Paws::RedShift::BatchModifyClusterSnapshots

Returns: a Paws::RedShift::BatchModifyClusterSnapshotsOutputMessage instance

Modifies the settings for a set of cluster snapshots.

Each argument is described in detail in: Paws::RedShift::CancelResize

Returns: a Paws::RedShift::ResizeProgressMessage instance

Cancels a resize operation for a cluster.

[ManualSnapshotRetentionPeriod => Int]
[SourceSnapshotClusterIdentifier => Str]

Each argument is described in detail in: Paws::RedShift::CopyClusterSnapshot

Returns: a Paws::RedShift::CopyClusterSnapshotResult instance

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

For more information about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the Amazon Redshift Cluster Management Guide.

[AdditionalInfo => Str]
[AllowVersionUpgrade => Bool]
[AquaConfigurationStatus => Str]
[AutomatedSnapshotRetentionPeriod => Int]
[AvailabilityZone => Str]
[AvailabilityZoneRelocation => Bool]
[ClusterParameterGroupName => Str]
[ClusterSecurityGroups => ArrayRef[Str|Undef]]
[ClusterSubnetGroupName => Str]
[ClusterType => Str]
[ClusterVersion => Str]
[DBName => Str]
[ElasticIp => Str]
[Encrypted => Bool]
[EnhancedVpcRouting => Bool]
[HsmClientCertificateIdentifier => Str]
[HsmConfigurationIdentifier => Str]
[IamRoles => ArrayRef[Str|Undef]]
[KmsKeyId => Str]
[MaintenanceTrackName => Str]
[ManualSnapshotRetentionPeriod => Int]
[NumberOfNodes => Int]
[Port => Int]
[PreferredMaintenanceWindow => Str]
[PubliclyAccessible => Bool]
[SnapshotScheduleIdentifier => Str]
[Tags => ArrayRef[Paws::RedShift::Tag]]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::CreateCluster

Returns: a Paws::RedShift::CreateClusterResult instance

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateClusterParameterGroup

Returns: a Paws::RedShift::CreateClusterParameterGroupResult instance

Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide.

[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateClusterSecurityGroup

Returns: a Paws::RedShift::CreateClusterSecurityGroupResult instance

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the Amazon Redshift Cluster Management Guide.

[ManualSnapshotRetentionPeriod => Int]
[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateClusterSnapshot

Returns: a Paws::RedShift::CreateClusterSnapshotResult instance

Creates a manual snapshot of the specified cluster. The cluster must be in the "available" state.

For more information about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the Amazon Redshift Cluster Management Guide.

[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateClusterSubnetGroup

Returns: a Paws::RedShift::CreateClusterSubnetGroupResult instance

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-cluster-subnet-groups.html) in the Amazon Redshift Cluster Management Guide.

[ClusterIdentifier => Str]
[ResourceOwner => Str]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::CreateEndpointAccess

Returns: a Paws::RedShift::EndpointAccess instance

Creates a Redshift-managed VPC endpoint.

[Enabled => Bool]
[EventCategories => ArrayRef[Str|Undef]]
[Severity => Str]
[SourceIds => ArrayRef[Str|Undef]]
[SourceType => Str]
[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateEventSubscription

Returns: a Paws::RedShift::CreateEventSubscriptionResult instance

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateHsmClientCertificate

Returns: a Paws::RedShift::CreateHsmClientCertificateResult instance

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html#working-with-HSM) in the Amazon Redshift Cluster Management Guide.

[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateHsmConfiguration

Returns: a Paws::RedShift::CreateHsmConfigurationResult instance

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-HSM.html) in the Amazon Redshift Cluster Management Guide.

[Enable => Bool]
[EndTime => Str]
[ScheduledActionDescription => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::RedShift::CreateScheduledAction

Returns: a Paws::RedShift::ScheduledAction instance

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the "ResizeCluster" API operation.

[KmsKeyId => Str]
[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateSnapshotCopyGrant

Returns: a Paws::RedShift::CreateSnapshotCopyGrantResult instance

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

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) in the Amazon Redshift Cluster Management Guide.

[DryRun => Bool]
[NextInvocations => Int]
[ScheduleDefinitions => ArrayRef[Str|Undef]]
[ScheduleDescription => Str]
[ScheduleIdentifier => Str]
[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateSnapshotSchedule

Returns: a Paws::RedShift::SnapshotSchedule instance

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

Each argument is described in detail in: Paws::RedShift::CreateTags

Returns: nothing

Adds tags to a cluster.

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

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

[BreachAction => Str]
[Period => Str]
[Tags => ArrayRef[Paws::RedShift::Tag]]

Each argument is described in detail in: Paws::RedShift::CreateUsageLimit

Returns: a Paws::RedShift::UsageLimit instance

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

[FinalClusterSnapshotIdentifier => Str]
[FinalClusterSnapshotRetentionPeriod => Int]
[SkipFinalClusterSnapshot => Bool]

Each argument is described in detail in: Paws::RedShift::DeleteCluster

Returns: a Paws::RedShift::DeleteClusterResult instance

Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to "false" and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

Each argument is described in detail in: Paws::RedShift::DeleteClusterParameterGroup

Returns: nothing

Deletes a specified Amazon Redshift parameter group.

You cannot delete a parameter group if it is associated with a cluster.

Each argument is described in detail in: Paws::RedShift::DeleteClusterSecurityGroup

Returns: nothing

Deletes an Amazon Redshift security group.

You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the Amazon Redshift Cluster Management Guide.

[SnapshotClusterIdentifier => Str]

Each argument is described in detail in: Paws::RedShift::DeleteClusterSnapshot

Returns: a Paws::RedShift::DeleteClusterSnapshotResult instance

Deletes the specified manual snapshot. The snapshot must be in the "available" state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

Each argument is described in detail in: Paws::RedShift::DeleteClusterSubnetGroup

Returns: nothing

Deletes the specified cluster subnet group.

Each argument is described in detail in: Paws::RedShift::DeleteEndpointAccess

Returns: a Paws::RedShift::EndpointAccess instance

Deletes a Redshift-managed VPC endpoint.

Each argument is described in detail in: Paws::RedShift::DeleteEventSubscription

Returns: nothing

Deletes an Amazon Redshift event notification subscription.

Each argument is described in detail in: Paws::RedShift::DeleteHsmClientCertificate

Returns: nothing

Deletes the specified HSM client certificate.

Each argument is described in detail in: Paws::RedShift::DeleteHsmConfiguration

Returns: nothing

Deletes the specified Amazon Redshift HSM configuration.

Each argument is described in detail in: Paws::RedShift::DeletePartner

Returns: a Paws::RedShift::PartnerIntegrationOutputMessage instance

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

Each argument is described in detail in: Paws::RedShift::DeleteScheduledAction

Returns: nothing

Deletes a scheduled action.

Each argument is described in detail in: Paws::RedShift::DeleteSnapshotCopyGrant

Returns: nothing

Deletes the specified snapshot copy grant.

Each argument is described in detail in: Paws::RedShift::DeleteSnapshotSchedule

Returns: nothing

Deletes a snapshot schedule.

Each argument is described in detail in: Paws::RedShift::DeleteTags

Returns: nothing

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

Each argument is described in detail in: Paws::RedShift::DeleteUsageLimit

Returns: nothing

Deletes a usage limit from a cluster.

[AttributeNames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeAccountAttributes

Returns: a Paws::RedShift::AccountAttributeList instance

Returns a list of attributes attached to an account

[ClusterIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::RedShift::DescribeClusterDbRevisions

Returns: a Paws::RedShift::ClusterDbRevisionsMessage instance

Returns an array of "ClusterDbRevision" objects.

[Marker => Str]
[MaxRecords => Int]
[ParameterGroupName => Str]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeClusterParameterGroups

Returns: a Paws::RedShift::ClusterParameterGroupsMessage instance

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide.

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

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

[Marker => Str]
[MaxRecords => Int]
[Source => Str]

Each argument is described in detail in: Paws::RedShift::DescribeClusterParameters

Returns: a Paws::RedShift::ClusterParameterGroupDetails instance

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide.

[ClusterIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeClusters

Returns: a Paws::RedShift::ClustersMessage instance

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

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

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

[ClusterSecurityGroupName => Str]
[Marker => Str]
[MaxRecords => Int]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeClusterSecurityGroups

Returns: a Paws::RedShift::ClusterSecurityGroupMessage instance

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the Amazon Redshift Cluster Management Guide.

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

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

[ClusterExists => Bool]
[ClusterIdentifier => Str]
[EndTime => Str]
[Marker => Str]
[MaxRecords => Int]
[OwnerAccount => Str]
[SnapshotIdentifier => Str]
[SnapshotType => Str]
[SortingEntities => ArrayRef[Paws::RedShift::SnapshotSortingEntity]]
[StartTime => Str]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeClusterSnapshots

Returns: a Paws::RedShift::SnapshotMessage instance

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

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

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

[ClusterSubnetGroupName => Str]
[Marker => Str]
[MaxRecords => Int]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeClusterSubnetGroups

Returns: a Paws::RedShift::ClusterSubnetGroupMessage instance

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

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

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

[MaintenanceTrackName => Str]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::RedShift::DescribeClusterTracks

Returns: a Paws::RedShift::TrackListMessage instance

Returns a list of all the available maintenance tracks.

[ClusterParameterGroupFamily => Str]
[ClusterVersion => Str]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::RedShift::DescribeClusterVersions

Returns: a Paws::RedShift::ClusterVersionsMessage instance

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::RedShift::DescribeDefaultClusterParameters

Returns: a Paws::RedShift::DescribeDefaultClusterParametersResult instance

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide.

[ClusterIdentifier => Str]
[EndpointName => Str]
[Marker => Str]
[MaxRecords => Int]
[ResourceOwner => Str]
[VpcId => Str]

Each argument is described in detail in: Paws::RedShift::DescribeEndpointAccess

Returns: a Paws::RedShift::EndpointAccessList instance

Describes a Redshift-managed VPC endpoint.

[Account => Str]
[ClusterIdentifier => Str]
[Grantee => Bool]
[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::RedShift::DescribeEndpointAuthorization

Returns: a Paws::RedShift::EndpointAuthorizationList instance

Describes an endpoint authorization.

[SourceType => Str]

Each argument is described in detail in: Paws::RedShift::DescribeEventCategories

Returns: a Paws::RedShift::EventCategoriesMessage instance

Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html).

[Duration => Int]
[EndTime => Str]
[Marker => Str]
[MaxRecords => Int]
[SourceIdentifier => Str]
[SourceType => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::RedShift::DescribeEvents

Returns: a Paws::RedShift::EventsMessage instance

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

[Marker => Str]
[MaxRecords => Int]
[SubscriptionName => Str]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeEventSubscriptions

Returns: a Paws::RedShift::EventSubscriptionsMessage instance

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

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

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

[HsmClientCertificateIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeHsmClientCertificates

Returns: a Paws::RedShift::HsmClientCertificateMessage instance

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

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

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

[HsmConfigurationIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeHsmConfigurations

Returns: a Paws::RedShift::HsmConfigurationMessage instance

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

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

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

Each argument is described in detail in: Paws::RedShift::DescribeLoggingStatus

Returns: a Paws::RedShift::LoggingStatus instance

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

[ClusterIdentifier => Str]
[Filters => ArrayRef[Paws::RedShift::NodeConfigurationOptionsFilter]]
[Marker => Str]
[MaxRecords => Int]
[OwnerAccount => Str]
[SnapshotIdentifier => Str]

Each argument is described in detail in: Paws::RedShift::DescribeNodeConfigurationOptions

Returns: a Paws::RedShift::NodeConfigurationOptionsMessage instance

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

[ClusterVersion => Str]
[Marker => Str]
[MaxRecords => Int]
[NodeType => Str]

Each argument is described in detail in: Paws::RedShift::DescribeOrderableClusterOptions

Returns: a Paws::RedShift::OrderableClusterOptionsMessage instance

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

[DatabaseName => Str]
[PartnerName => Str]

Each argument is described in detail in: Paws::RedShift::DescribePartners

Returns: a Paws::RedShift::DescribePartnersOutputMessage instance

Returns information about the partner integrations defined for a cluster.

[Marker => Str]
[MaxRecords => Int]
[ReservedNodeOfferingId => Str]

Each argument is described in detail in: Paws::RedShift::DescribeReservedNodeOfferings

Returns: a Paws::RedShift::ReservedNodeOfferingsMessage instance

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

For more information about reserved node offerings, go to Purchasing Reserved Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html) in the Amazon Redshift Cluster Management Guide.

[Marker => Str]
[MaxRecords => Int]
[ReservedNodeId => Str]

Each argument is described in detail in: Paws::RedShift::DescribeReservedNodes

Returns: a Paws::RedShift::ReservedNodesMessage instance

Returns the descriptions of the reserved nodes.

Each argument is described in detail in: Paws::RedShift::DescribeResize

Returns: a Paws::RedShift::ResizeProgressMessage instance

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

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

[Active => Bool]
[EndTime => Str]
[Filters => ArrayRef[Paws::RedShift::ScheduledActionFilter]]
[Marker => Str]
[MaxRecords => Int]
[ScheduledActionName => Str]
[StartTime => Str]
[TargetActionType => Str]

Each argument is described in detail in: Paws::RedShift::DescribeScheduledActions

Returns: a Paws::RedShift::ScheduledActionsMessage instance

Describes properties of scheduled actions.

[Marker => Str]
[MaxRecords => Int]
[SnapshotCopyGrantName => Str]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeSnapshotCopyGrants

Returns: a Paws::RedShift::SnapshotCopyGrantMessage instance

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

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html) in the Amazon Redshift Cluster Management Guide.

[ClusterIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]
[ScheduleIdentifier => Str]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeSnapshotSchedules

Returns: a Paws::RedShift::DescribeSnapshotSchedulesOutputMessage instance

Returns a list of snapshot schedules.

=>

Each argument is described in detail in: Paws::RedShift::DescribeStorage

Returns: a Paws::RedShift::CustomerStorageMessage instance

Returns account level backups storage size and provisional storage.

[ClusterIdentifier => Str]
[Marker => Str]
[MaxRecords => Int]
[TableRestoreRequestId => Str]

Each argument is described in detail in: Paws::RedShift::DescribeTableRestoreStatus

Returns: a Paws::RedShift::TableRestoreStatusMessage instance

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

[Marker => Str]
[MaxRecords => Int]
[ResourceName => Str]
[ResourceType => Str]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::DescribeTags

Returns: a Paws::RedShift::TaggedResourceListMessage instance

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

The following are limitations for "DescribeTags":

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

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

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

[ClusterIdentifier => Str]
[FeatureType => Str]
[Marker => Str]
[MaxRecords => Int]
[TagKeys => ArrayRef[Str|Undef]]
[TagValues => ArrayRef[Str|Undef]]
[UsageLimitId => Str]

Each argument is described in detail in: Paws::RedShift::DescribeUsageLimits

Returns: a Paws::RedShift::UsageLimitList instance

Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

  • If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.
  • If usage limit identifier is provided, then the corresponding usage limit object is returned.
  • If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.
  • If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.

Each argument is described in detail in: Paws::RedShift::DisableLogging

Returns: a Paws::RedShift::LoggingStatus instance

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

Each argument is described in detail in: Paws::RedShift::DisableSnapshotCopy

Returns: a Paws::RedShift::DisableSnapshotCopyResult instance

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

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

[S3KeyPrefix => Str]

Each argument is described in detail in: Paws::RedShift::EnableLogging

Returns: a Paws::RedShift::LoggingStatus instance

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

[ManualSnapshotRetentionPeriod => Int]
[RetentionPeriod => Int]
[SnapshotCopyGrantName => Str]

Each argument is described in detail in: Paws::RedShift::EnableSnapshotCopy

Returns: a Paws::RedShift::EnableSnapshotCopyResult instance

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

[AutoCreate => Bool]
[DbGroups => ArrayRef[Str|Undef]]
[DbName => Str]
[DurationSeconds => Int]

Each argument is described in detail in: Paws::RedShift::GetClusterCredentials

Returns: a Paws::RedShift::ClusterCredentials instance

Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with "IAM:" if "AutoCreate" is "False" or "IAMA:" if "AutoCreate" is "True". You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials (https://docs.aws.amazon.com/redshift/latest/mgmt/generating-user-credentials.html) in the Amazon Redshift Cluster Management Guide.

The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html#redshift-policy-resources.getclustercredentials-resources) in the Amazon Redshift Cluster Management Guide.

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

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

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

[Marker => Str]
[MaxRecords => Int]

Each argument is described in detail in: Paws::RedShift::GetReservedNodeExchangeOfferings

Returns: a Paws::RedShift::GetReservedNodeExchangeOfferingsOutputMessage instance

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

[AquaConfigurationStatus => Str]

Each argument is described in detail in: Paws::RedShift::ModifyAquaConfiguration

Returns: a Paws::RedShift::ModifyAquaOutputMessage instance

Modifies whether a cluster can use AQUA (Advanced Query Accelerator).

[AllowVersionUpgrade => Bool]
[AutomatedSnapshotRetentionPeriod => Int]
[AvailabilityZone => Str]
[AvailabilityZoneRelocation => Bool]
[ClusterParameterGroupName => Str]
[ClusterSecurityGroups => ArrayRef[Str|Undef]]
[ClusterType => Str]
[ClusterVersion => Str]
[ElasticIp => Str]
[Encrypted => Bool]
[EnhancedVpcRouting => Bool]
[HsmClientCertificateIdentifier => Str]
[HsmConfigurationIdentifier => Str]
[KmsKeyId => Str]
[MaintenanceTrackName => Str]
[ManualSnapshotRetentionPeriod => Int]
[MasterUserPassword => Str]
[NewClusterIdentifier => Str]
[NodeType => Str]
[NumberOfNodes => Int]
[Port => Int]
[PreferredMaintenanceWindow => Str]
[PubliclyAccessible => Bool]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::ModifyCluster

Returns: a Paws::RedShift::ModifyClusterResult instance

Modifies the settings for a cluster.

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

You can add another security or parameter group, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

Each argument is described in detail in: Paws::RedShift::ModifyClusterDbRevision

Returns: a Paws::RedShift::ModifyClusterDbRevisionResult instance

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

[AddIamRoles => ArrayRef[Str|Undef]]
[RemoveIamRoles => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::ModifyClusterIamRoles

Returns: a Paws::RedShift::ModifyClusterIamRolesResult instance

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

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

[DeferMaintenance => Bool]
[DeferMaintenanceDuration => Int]
[DeferMaintenanceEndTime => Str]
[DeferMaintenanceIdentifier => Str]
[DeferMaintenanceStartTime => Str]

Each argument is described in detail in: Paws::RedShift::ModifyClusterMaintenance

Returns: a Paws::RedShift::ModifyClusterMaintenanceResult instance

Modifies the maintenance settings of a cluster.

Each argument is described in detail in: Paws::RedShift::ModifyClusterParameterGroup

Returns: a Paws::RedShift::ClusterParameterGroupNameMessage instance

Modifies the parameters of a parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-parameter-groups.html) in the Amazon Redshift Cluster Management Guide.

[Force => Bool]
[ManualSnapshotRetentionPeriod => Int]

Each argument is described in detail in: Paws::RedShift::ModifyClusterSnapshot

Returns: a Paws::RedShift::ModifyClusterSnapshotResult instance

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

[DisassociateSchedule => Bool]
[ScheduleIdentifier => Str]

Each argument is described in detail in: Paws::RedShift::ModifyClusterSnapshotSchedule

Returns: nothing

Modifies a snapshot schedule for a cluster.

[Description => Str]

Each argument is described in detail in: Paws::RedShift::ModifyClusterSubnetGroup

Returns: a Paws::RedShift::ModifyClusterSubnetGroupResult instance

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

[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::ModifyEndpointAccess

Returns: a Paws::RedShift::EndpointAccess instance

Modifies a Redshift-managed VPC endpoint.

[Enabled => Bool]
[EventCategories => ArrayRef[Str|Undef]]
[Severity => Str]
[SnsTopicArn => Str]
[SourceIds => ArrayRef[Str|Undef]]
[SourceType => Str]

Each argument is described in detail in: Paws::RedShift::ModifyEventSubscription

Returns: a Paws::RedShift::ModifyEventSubscriptionResult instance

Modifies an existing Amazon Redshift event notification subscription.

[Enable => Bool]
[EndTime => Str]
[IamRole => Str]
[Schedule => Str]
[ScheduledActionDescription => Str]
[StartTime => Str]
[TargetAction => Paws::RedShift::ScheduledActionType]

Each argument is described in detail in: Paws::RedShift::ModifyScheduledAction

Returns: a Paws::RedShift::ScheduledAction instance

Modifies a scheduled action.

[Manual => Bool]

Each argument is described in detail in: Paws::RedShift::ModifySnapshotCopyRetentionPeriod

Returns: a Paws::RedShift::ModifySnapshotCopyRetentionPeriodResult instance

Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Each argument is described in detail in: Paws::RedShift::ModifySnapshotSchedule

Returns: a Paws::RedShift::SnapshotSchedule instance

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

[Amount => Int]
[BreachAction => Str]

Each argument is described in detail in: Paws::RedShift::ModifyUsageLimit

Returns: a Paws::RedShift::UsageLimit instance

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Each argument is described in detail in: Paws::RedShift::PauseCluster

Returns: a Paws::RedShift::PauseClusterResult instance

Pauses a cluster.

[NodeCount => Int]

Each argument is described in detail in: Paws::RedShift::PurchaseReservedNodeOffering

Returns: a Paws::RedShift::PurchaseReservedNodeOfferingResult instance

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

For more information about reserved node offerings, go to Purchasing Reserved Nodes (https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-instance.html) in the Amazon Redshift Cluster Management Guide.

Each argument is described in detail in: Paws::RedShift::RebootCluster

Returns: a Paws::RedShift::RebootClusterResult instance

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to "rebooting". A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html) in the Amazon Redshift Cluster Management Guide.

[Parameters => ArrayRef[Paws::RedShift::Parameter]]
[ResetAllParameters => Bool]

Each argument is described in detail in: Paws::RedShift::ResetClusterParameterGroup

Returns: a Paws::RedShift::ClusterParameterGroupNameMessage instance

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

[Classic => Bool]
[ClusterType => Str]
[NodeType => Str]
[NumberOfNodes => Int]

Each argument is described in detail in: Paws::RedShift::ResizeCluster

Returns: a Paws::RedShift::ResizeClusterResult instance

Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.

Elastic resize operations have the following restrictions:

•
You can only resize clusters of the following types:
  • dc1.large (if your cluster is in a VPC)
  • dc1.8xlarge (if your cluster is in a VPC)
  • dc2.large
  • dc2.8xlarge
  • ds2.xlarge
  • ds2.8xlarge
  • ra3.xlplus
  • ra3.4xlarge
  • ra3.16xlarge
•
The type of nodes that you add must match the node type for the cluster.

[AdditionalInfo => Str]
[AllowVersionUpgrade => Bool]
[AquaConfigurationStatus => Str]
[AutomatedSnapshotRetentionPeriod => Int]
[AvailabilityZone => Str]
[AvailabilityZoneRelocation => Bool]
[ClusterParameterGroupName => Str]
[ClusterSecurityGroups => ArrayRef[Str|Undef]]
[ClusterSubnetGroupName => Str]
[ElasticIp => Str]
[EnhancedVpcRouting => Bool]
[HsmClientCertificateIdentifier => Str]
[HsmConfigurationIdentifier => Str]
[IamRoles => ArrayRef[Str|Undef]]
[KmsKeyId => Str]
[MaintenanceTrackName => Str]
[ManualSnapshotRetentionPeriod => Int]
[NodeType => Str]
[NumberOfNodes => Int]
[OwnerAccount => Str]
[Port => Int]
[PreferredMaintenanceWindow => Str]
[PubliclyAccessible => Bool]
[SnapshotClusterIdentifier => Str]
[SnapshotScheduleIdentifier => Str]
[VpcSecurityGroupIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::RestoreFromClusterSnapshot

Returns: a Paws::RedShift::RestoreFromClusterSnapshotResult instance

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

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

For more information about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the Amazon Redshift Cluster Management Guide.

[EnableCaseSensitiveIdentifier => Bool]
[SourceSchemaName => Str]
[TargetDatabaseName => Str]
[TargetSchemaName => Str]

Each argument is described in detail in: Paws::RedShift::RestoreTableFromClusterSnapshot

Returns: a Paws::RedShift::RestoreTableFromClusterSnapshotResult instance

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

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

Each argument is described in detail in: Paws::RedShift::ResumeCluster

Returns: a Paws::RedShift::ResumeClusterResult instance

Resumes a paused cluster.

[CIDRIP => Str]
[EC2SecurityGroupName => Str]
[EC2SecurityGroupOwnerId => Str]

Each argument is described in detail in: Paws::RedShift::RevokeClusterSecurityGroupIngress

Returns: a Paws::RedShift::RevokeClusterSecurityGroupIngressResult instance

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html) in the Amazon Redshift Cluster Management Guide.

[Account => Str]
[ClusterIdentifier => Str]
[Force => Bool]
[VpcIds => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::RedShift::RevokeEndpointAccess

Returns: a Paws::RedShift::EndpointAuthorization instance

Revokes access to a cluster.

[SnapshotClusterIdentifier => Str]

Each argument is described in detail in: Paws::RedShift::RevokeSnapshotAccess

Returns: a Paws::RedShift::RevokeSnapshotAccessResult instance

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

For more information about working with snapshots, go to Amazon Redshift Snapshots (https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html) in the Amazon Redshift Cluster Management Guide.

Each argument is described in detail in: Paws::RedShift::RotateEncryptionKey

Returns: a Paws::RedShift::RotateEncryptionKeyResult instance

Rotates the encryption keys for a cluster.

[StatusMessage => Str]

Each argument is described in detail in: Paws::RedShift::UpdatePartnerStatus

Returns: a Paws::RedShift::PartnerIntegrationOutputMessage instance

Updates the status of a partner integration.

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClusterDbRevisions, passing the object as the first parameter, and the string 'ClusterDbRevisions' as the second parameter

If not, it will return a a Paws::RedShift::ClusterDbRevisionsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ParameterGroups, passing the object as the first parameter, and the string 'ParameterGroups' as the second parameter

If not, it will return a a Paws::RedShift::ClusterParameterGroupsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Parameters, passing the object as the first parameter, and the string 'Parameters' as the second parameter

If not, it will return a a Paws::RedShift::ClusterParameterGroupDetails instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Clusters, passing the object as the first parameter, and the string 'Clusters' as the second parameter

If not, it will return a a Paws::RedShift::ClustersMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClusterSecurityGroups, passing the object as the first parameter, and the string 'ClusterSecurityGroups' as the second parameter

If not, it will return a a Paws::RedShift::ClusterSecurityGroupMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Snapshots, passing the object as the first parameter, and the string 'Snapshots' as the second parameter

If not, it will return a a Paws::RedShift::SnapshotMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClusterSubnetGroups, passing the object as the first parameter, and the string 'ClusterSubnetGroups' as the second parameter

If not, it will return a a Paws::RedShift::ClusterSubnetGroupMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - MaintenanceTracks, passing the object as the first parameter, and the string 'MaintenanceTracks' as the second parameter

If not, it will return a a Paws::RedShift::TrackListMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ClusterVersions, passing the object as the first parameter, and the string 'ClusterVersions' as the second parameter

If not, it will return a a Paws::RedShift::ClusterVersionsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - DefaultClusterParameters.Parameters, passing the object as the first parameter, and the string 'DefaultClusterParameters.Parameters' as the second parameter

If not, it will return a a Paws::RedShift::DescribeDefaultClusterParametersResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - EndpointAccessList, passing the object as the first parameter, and the string 'EndpointAccessList' as the second parameter

If not, it will return a a Paws::RedShift::EndpointAccessList instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - EndpointAuthorizationList, passing the object as the first parameter, and the string 'EndpointAuthorizationList' as the second parameter

If not, it will return a a Paws::RedShift::EndpointAuthorizationList instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - Events, passing the object as the first parameter, and the string 'Events' as the second parameter

If not, it will return a a Paws::RedShift::EventsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - EventSubscriptionsList, passing the object as the first parameter, and the string 'EventSubscriptionsList' as the second parameter

If not, it will return a a Paws::RedShift::EventSubscriptionsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - HsmClientCertificates, passing the object as the first parameter, and the string 'HsmClientCertificates' as the second parameter

If not, it will return a a Paws::RedShift::HsmClientCertificateMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - HsmConfigurations, passing the object as the first parameter, and the string 'HsmConfigurations' as the second parameter

If not, it will return a a Paws::RedShift::HsmConfigurationMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - NodeConfigurationOptionList, passing the object as the first parameter, and the string 'NodeConfigurationOptionList' as the second parameter

If not, it will return a a Paws::RedShift::NodeConfigurationOptionsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - OrderableClusterOptions, passing the object as the first parameter, and the string 'OrderableClusterOptions' as the second parameter

If not, it will return a a Paws::RedShift::OrderableClusterOptionsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ReservedNodeOfferings, passing the object as the first parameter, and the string 'ReservedNodeOfferings' as the second parameter

If not, it will return a a Paws::RedShift::ReservedNodeOfferingsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ReservedNodes, passing the object as the first parameter, and the string 'ReservedNodes' as the second parameter

If not, it will return a a Paws::RedShift::ReservedNodesMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ScheduledActions, passing the object as the first parameter, and the string 'ScheduledActions' as the second parameter

If not, it will return a a Paws::RedShift::ScheduledActionsMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - SnapshotCopyGrants, passing the object as the first parameter, and the string 'SnapshotCopyGrants' as the second parameter

If not, it will return a a Paws::RedShift::SnapshotCopyGrantMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - SnapshotSchedules, passing the object as the first parameter, and the string 'SnapshotSchedules' as the second parameter

If not, it will return a a Paws::RedShift::DescribeSnapshotSchedulesOutputMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - TableRestoreStatusDetails, passing the object as the first parameter, and the string 'TableRestoreStatusDetails' as the second parameter

If not, it will return a a Paws::RedShift::TableRestoreStatusMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - TaggedResources, passing the object as the first parameter, and the string 'TaggedResources' as the second parameter

If not, it will return a a Paws::RedShift::TaggedResourceListMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - UsageLimits, passing the object as the first parameter, and the string 'UsageLimits' as the second parameter

If not, it will return a a Paws::RedShift::UsageLimitList instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - ReservedNodeOfferings, passing the object as the first parameter, and the string 'ReservedNodeOfferings' as the second parameter

If not, it will return a a Paws::RedShift::GetReservedNodeExchangeOfferingsOutputMessage instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.