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->AllowVersionUpgradeDESCRIPTION
Describes a cluster.
ATTRIBUTES
AllowVersionUpgrade => Bool
A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
AquaConfiguration => Paws::RedShift::AquaConfiguration
The AQUA (Advanced Query Accelerator) configuration of the cluster.
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.
AvailabilityZoneRelocationStatus => Str
Describes the status of the Availability Zone relocation operation.
ClusterAvailabilityStatus => Str
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ClusterCreateTime => Str
The date and time that the cluster was created.
ClusterIdentifier => Str
The unique identifier of the cluster.
ClusterNamespaceArn => Str
The namespace Amazon Resource Name (ARN) of the cluster.
ClusterNodes => ArrayRef[Paws::RedShift::ClusterNode]
The nodes in the 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 ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
ClusterSnapshotCopyStatus => Paws::RedShift::ClusterSnapshotCopyStatus
A value that 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 the following:
availableavailable, prep-for-resizeavailable, resize-cleanupcancelling-resizecreatingdeletingfinal-snapshothardware-failureincompatible-hsmincompatible-networkincompatible-parametersincompatible-restoremodifyingpausedrebootingrenamingresizingrotating-keysstorage-fullupdating-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.
DataTransferProgress => Paws::RedShift::DataTransferProgress
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 devdev was created by default.
DeferredMaintenanceWindows => ArrayRef[Paws::RedShift::DeferredMaintenanceWindow]
Describes a group of DeferredMaintenanceWindow objects.
ElasticIpStatus => Paws::RedShift::ElasticIpStatus
The status of the elastic IP (EIP) address.
ElasticResizeNumberOfNodeOptions => Str
The number of nodes that you can resize the cluster to with the elastic resize method.
Encrypted => Bool
A boolean value that, if true, indicates that data in the cluster is encrypted at rest.
Endpoint => Paws::RedShift::Endpoint
The connection endpoint.
EnhancedVpcRouting => Bool
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) in the Amazon Redshift Cluster Management Guide.
If this option is true, enhanced VPC routing is enabled.
Default: false
ExpectedNextSnapshotScheduleTime => Str
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus => Str
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
HsmStatus => Paws::RedShift::HsmStatus
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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 (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.
MaintenanceTrackName => Str
The name of the maintenance track for the cluster.
ManualSnapshotRetentionPeriod => Int
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
MasterUsername => Str
The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
ModifyStatus => Str
The status of a modify operation, if any, initiated for the cluster.
NextMaintenanceWindowStartTime => Str
The date and time in UTC when system maintenance can begin.
NodeType => Str
The node type for the nodes in the cluster.
NumberOfNodes => Int
The number of compute nodes in the cluster.
PendingActions => ArrayRef[Str|Undef]
Cluster operations that are waiting to be started.
PendingModifiedValues => Paws::RedShift::PendingModifiedValues
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
PreferredMaintenanceWindow => Str
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
PubliclyAccessible => Bool
A boolean value that, if true, indicates that the cluster can be accessed from a public network.
ResizeInfo => Paws::RedShift::ResizeInfo
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
RestoreStatus => Paws::RedShift::RestoreStatus
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
SnapshotScheduleIdentifier => Str
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState => Str
The current state of the cluster snapshot schedule.
Tags => ArrayRef[Paws::RedShift::Tag]
The list of tags for the cluster.
TotalStorageCapacityInMegaBytes => Int
The total storage capacity of the cluster in megabytes.
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 Amazon Virtual Private Cloud (Amazon 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