view release on metacpan or  search on metacpan

lib/Paws/RedShift/Cluster.pm  view on Meta::CPAN

1;

### main pod documentation begin ###

=head1 NAME

Paws::RedShift::Cluster

=head1 USAGE

This class represents one of two things:

=head3 Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. 
Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::RedShift::Cluster object:

  $service_obj->Method(Att1 => { AllowVersionUpgrade => $value, ..., VpcSecurityGroups => $value  });

=head3 Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::Cluster object:

  $result = $service_obj->Method(...);
  $result->Att1->AllowVersionUpgrade

=head1 DESCRIPTION

Describes a cluster.

=head1 ATTRIBUTES


=head2 AllowVersionUpgrade => Bool

A boolean value that, if C<true>, indicates that major version upgrades
will be applied automatically to the cluster during the maintenance
window.


=head2 AquaConfiguration => L<Paws::RedShift::AquaConfiguration>

The AQUA (Advanced Query Accelerator) configuration of the cluster.


=head2 AutomatedSnapshotRetentionPeriod => Int

The number of days that automatic cluster snapshots are retained.


=head2 AvailabilityZone => Str

The name of the Availability Zone in which the cluster is located.


=head2 AvailabilityZoneRelocationStatus => Str

Describes the status of the Availability Zone relocation operation.


=head2 ClusterAvailabilityStatus => Str

The availability status of the cluster for queries. Possible values are
the following:

=over

=item *

Available - The cluster is available for queries.

=item *

Unavailable - The cluster is not available for queries.

=item *

Maintenance - The cluster is intermittently available for queries due
to maintenance activities.

=item *

Modifying - The cluster is intermittently available for queries due to
changes that modify the cluster.

=item *

Failed - The cluster failed and is not available for queries.

=back



=head2 ClusterCreateTime => Str

The date and time that the cluster was created.


=head2 ClusterIdentifier => Str

The unique identifier of the cluster.


=head2 ClusterNamespaceArn => Str

The namespace Amazon Resource Name (ARN) of the cluster.


=head2 ClusterNodes => ArrayRef[L<Paws::RedShift::ClusterNode>]

The nodes in the cluster.


=head2 ClusterParameterGroups => ArrayRef[L<Paws::RedShift::ClusterParameterGroupStatus>]

The list of cluster parameter groups that are associated with this
cluster. Each parameter group in the list is returned with its status.