/ 
Paws-0.23
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedShift::Cluster

NAME

Paws::RedShift::Cluster

USAGE

This class represents one of two things:

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

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

DESCRIPTION

Describes a cluster.

ATTRIBUTES

AllowVersionUpgrade => Bool

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

AutomatedSnapshotRetentionPeriod => Int

The number of days that automatic cluster snapshots are retained.

AvailabilityZone => Str

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

ClusterCreateTime => Str

The date and time that the cluster was created.

ClusterIdentifier => Str

The unique identifier of the cluster.

ClusterNodes => ArrayRef[Paws::RedShift::ClusterNode]

The nodes in a cluster.

ClusterParameterGroups => ArrayRef[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.

ClusterPublicKey => Str

The public key for the cluster.

ClusterRevisionNumber => Str

The specific revision number of the database in the cluster.

ClusterSecurityGroups => ArrayRef[Paws::RedShift::ClusterSecurityGroupMembership]

A list of cluster security group that are associated with the cluster.
Each security group is represented by an element that contains
C<ClusterSecurityGroup.Name> and C<ClusterSecurityGroup.Status>
subelements.

Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

ClusterSnapshotCopyStatus => Paws::RedShift::ClusterSnapshotCopyStatus

Returns the destination region and retention period that are configured
for cross-region snapshot copy.

ClusterStatus => Str

The current state of the cluster. Possible values are:

  • available

  • creating

  • deleting

  • final-snapshot

  • hardware-failure

  • incompatible-hsm

  • incompatible-network

  • incompatible-parameters

  • incompatible-restore

  • modifying

  • rebooting

  • renaming

  • resizing

  • rotating-keys

  • storage-full

  • updating-hsm

ClusterSubnetGroupName => Str

The name of the subnet group that is associated with the cluster. This
parameter is valid only when the cluster is in a VPC.

ClusterVersion => Str

The version ID of the Amazon Redshift engine that is running on the
cluster.

DBName => Str

The name of the initial database that was created when the cluster was
created. This same name is returned for the life of the cluster. If an
initial database was not specified, a database named "dev" was created
by default.

ElasticIpStatus => Paws::RedShift::ElasticIpStatus

The status of the elastic IP (EIP) address.

Encrypted => Bool

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

Endpoint => Paws::RedShift::Endpoint

The connection endpoint.

HsmStatus => Paws::RedShift::HsmStatus

Reports whether the Amazon Redshift cluster has finished applying any
HSM settings changes specified in a modify cluster command.

Values: active, applying

IamRoles => ArrayRef[Paws::RedShift::ClusterIamRole]

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

KmsKeyId => Str

The AWS Key Management Service (KMS) key ID of the encryption key used
to encrypt data in the cluster.

MasterUsername => Str

The master user name for the cluster. This name is used to connect to
the database that is specified in B<DBName>.

ModifyStatus => Str

The status of a modify operation, if any, initiated for the cluster.

NodeType => Str

The node type for the nodes in the cluster.

NumberOfNodes => Int

The number of compute nodes in the cluster.

PendingModifiedValues => Paws::RedShift::PendingModifiedValues

If present, changes to the cluster are pending. Specific pending
changes are identified by subelements.

PreferredMaintenanceWindow => Str

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

PubliclyAccessible => Bool

If C<true>, the cluster can be accessed from a public network.

RestoreStatus => Paws::RedShift::RestoreStatus

Describes the status of a cluster restore action. Returns null if the
cluster was not created by restoring a snapshot.

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

The list of tags for the cluster.

VpcId => Str

The identifier of the VPC the cluster is in, if the cluster is in a
VPC.

VpcSecurityGroups => ArrayRef[Paws::RedShift::VpcSecurityGroupMembership]

A list of Virtual Private Cloud (VPC) security groups that are
associated with the cluster. This parameter is returned only if the
cluster is in a VPC.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::RedShift

BUGS and CONTRIBUTIONS

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