« blib/lib/Paws/RedShift/RevokeClusterSecurityGroupIngressResult.pm
↑ Summary
blib/lib/Paws/RedShift/SnapshotMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RedShift::Snapshot; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has AccountsWithRestoreAccess => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::AccountWithRestoreAccess]', request_name => 'AccountWithRestoreAccess', traits => ['NameInRequest']); | |
| 5 | 1 | has ActualIncrementalBackupSizeInMegaBytes => (is => 'ro', isa => 'Num'); | |
| 6 | 1 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | |
| 7 | 1 | has BackupProgressInMegaBytes => (is => 'ro', isa => 'Num'); | |
| 8 | 1 | has ClusterCreateTime => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has ClusterIdentifier => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has ClusterVersion => (is => 'ro', isa => 'Str'); | |
| 11 | 1 | has CurrentBackupRateInMegaBytesPerSecond => (is => 'ro', isa => 'Num'); | |
| 12 | 1 | has DBName => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has ElapsedTimeInSeconds => (is => 'ro', isa => 'Int'); | |
| 14 | 1 | has Encrypted => (is => 'ro', isa => 'Bool'); | |
| 15 | 1 | has EncryptedWithHSM => (is => 'ro', isa => 'Bool'); | |
| 16 | 1 | has EngineFullVersion => (is => 'ro', isa => 'Str'); | |
| 17 | 1 | has EnhancedVpcRouting => (is => 'ro', isa => 'Bool'); | |
| 18 | 1 | has EstimatedSecondsToCompletion => (is => 'ro', isa => 'Int'); | |
| 19 | 1 | has KmsKeyId => (is => 'ro', isa => 'Str'); | |
| 20 | 1 | has MaintenanceTrackName => (is => 'ro', isa => 'Str'); | |
| 21 | 1 | has ManualSnapshotRemainingDays => (is => 'ro', isa => 'Int'); | |
| 22 | 1 | has ManualSnapshotRetentionPeriod => (is => 'ro', isa => 'Int'); | |
| 23 | 1 | has MasterUsername => (is => 'ro', isa => 'Str'); | |
| 24 | 1 | has NodeType => (is => 'ro', isa => 'Str'); | |
| 25 | 1 | has NumberOfNodes => (is => 'ro', isa => 'Int'); | |
| 26 | 1 | has OwnerAccount => (is => 'ro', isa => 'Str'); | |
| 27 | 1 | has Port => (is => 'ro', isa => 'Int'); | |
| 28 | 1 | has RestorableNodeTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'NodeType', traits => ['NameInRequest']); | |
| 29 | 1 | has SnapshotCreateTime => (is => 'ro', isa => 'Str'); | |
| 30 | 1 | has SnapshotIdentifier => (is => 'ro', isa => 'Str'); | |
| 31 | 1 | has SnapshotRetentionStartTime => (is => 'ro', isa => 'Str'); | |
| 32 | 1 | has SnapshotType => (is => 'ro', isa => 'Str'); | |
| 33 | 1 | has SourceRegion => (is => 'ro', isa => 'Str'); | |
| 34 | 1 | has Status => (is => 'ro', isa => 'Str'); | |
| 35 | 1 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]', request_name => 'Tag', traits => ['NameInRequest']); | |
| 36 | 1 | has TotalBackupSizeInMegaBytes => (is => 'ro', isa => 'Num'); | |
| 37 | 1 | has VpcId => (is => 'ro', isa => 'Str'); | |
| 38 | |||
| 39 | 1 | 1; | |
| 40 | |||
| 41 | ### main pod documentation begin ### | ||
| 42 | |||
| 43 | =head1 NAME | ||
| 44 | |||
| 45 | Paws::RedShift::Snapshot | ||
| 46 | |||
| 47 | =head1 USAGE | ||
| 48 | |||
| 49 | This class represents one of two things: | ||
| 50 | |||
| 51 | =head3 Arguments in a call to a service | ||
| 52 | |||
| 53 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 54 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 55 | |||
| 56 | As an example, if Att1 is expected to be a Paws::RedShift::Snapshot object: | ||
| 57 | |||
| 58 | $service_obj->Method(Att1 => { AccountsWithRestoreAccess => $value, ..., VpcId => $value }); | ||
| 59 | |||
| 60 | =head3 Results returned from an API call | ||
| 61 | |||
| 62 | Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::Snapshot object: | ||
| 63 | |||
| 64 | $result = $service_obj->Method(...); | ||
| 65 | $result->Att1->AccountsWithRestoreAccess | ||
| 66 | |||
| 67 | =head1 DESCRIPTION | ||
| 68 | |||
| 69 | Describes a snapshot. | ||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 AccountsWithRestoreAccess => ArrayRef[L<Paws::RedShift::AccountWithRestoreAccess>] | ||
| 75 | |||
| 76 | A list of the AWS customer accounts authorized to restore the snapshot. | ||
| 77 | Returns C<null> if no accounts are authorized. Visible only to the | ||
| 78 | snapshot owner. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 ActualIncrementalBackupSizeInMegaBytes => Num | ||
| 82 | |||
| 83 | The size of the incremental backup. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 AvailabilityZone => Str | ||
| 87 | |||
| 88 | The Availability Zone in which the cluster was created. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 BackupProgressInMegaBytes => Num | ||
| 92 | |||
| 93 | The number of megabytes that have been transferred to the snapshot | ||
| 94 | backup. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 ClusterCreateTime => Str | ||
| 98 | |||
| 99 | The time (UTC) when the cluster was originally created. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 ClusterIdentifier => Str | ||
| 103 | |||
| 104 | The identifier of the cluster for which the snapshot was taken. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 ClusterVersion => Str | ||
| 108 | |||
| 109 | The version ID of the Amazon Redshift engine that is running on the | ||
| 110 | cluster. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 CurrentBackupRateInMegaBytesPerSecond => Num | ||
| 114 | |||
| 115 | The number of megabytes per second being transferred to the snapshot | ||
| 116 | backup. Returns C<0> for a completed backup. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 DBName => Str | ||
| 120 | |||
| 121 | The name of the database that was created when the cluster was created. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 ElapsedTimeInSeconds => Int | ||
| 125 | |||
| 126 | The amount of time an in-progress snapshot backup has been running, or | ||
| 127 | the amount of time it took a completed backup to finish. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Encrypted => Bool | ||
| 131 | |||
| 132 | If C<true>, the data in the snapshot is encrypted at rest. | ||
| 133 | |||
| 134 | |||
| 135 | =head2 EncryptedWithHSM => Bool | ||
| 136 | |||
| 137 | A boolean that indicates whether the snapshot data is encrypted using | ||
| 138 | the HSM keys of the source cluster. C<true> indicates that the data is | ||
| 139 | encrypted using HSM keys. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 EngineFullVersion => Str | ||
| 143 | |||
| 144 | The cluster version of the cluster used to create the snapshot. For | ||
| 145 | example, 1.0.15503. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 EnhancedVpcRouting => Bool | ||
| 149 | |||
| 150 | An option that specifies whether to create the cluster with enhanced | ||
| 151 | VPC routing enabled. To create a cluster that uses enhanced VPC | ||
| 152 | routing, the cluster must be in a VPC. For more information, see | ||
| 153 | Enhanced VPC Routing | ||
| 154 | (https://docs.aws.amazon.com/redshift/latest/mgmt/enhanced-vpc-routing.html) | ||
| 155 | in the Amazon Redshift Cluster Management Guide. | ||
| 156 | |||
| 157 | If this option is C<true>, enhanced VPC routing is enabled. | ||
| 158 | |||
| 159 | Default: false | ||
| 160 | |||
| 161 | |||
| 162 | =head2 EstimatedSecondsToCompletion => Int | ||
| 163 | |||
| 164 | The estimate of the time remaining before the snapshot backup will | ||
| 165 | complete. Returns C<0> for a completed backup. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 KmsKeyId => Str | ||
| 169 | |||
| 170 | The AWS Key Management Service (KMS) key ID of the encryption key that | ||
| 171 | was used to encrypt data in the cluster from which the snapshot was | ||
| 172 | taken. | ||
| 173 | |||
| 174 | |||
| 175 | =head2 MaintenanceTrackName => Str | ||
| 176 | |||
| 177 | The name of the maintenance track for the snapshot. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 ManualSnapshotRemainingDays => Int | ||
| 181 | |||
| 182 | The number of days until a manual snapshot will pass its retention | ||
| 183 | period. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 ManualSnapshotRetentionPeriod => Int | ||
| 187 | |||
| 188 | The number of days that a manual snapshot is retained. If the value is | ||
| 189 | -1, the manual snapshot is retained indefinitely. | ||
| 190 | |||
| 191 | The value must be either -1 or an integer between 1 and 3,653. | ||
| 192 | |||
| 193 | |||
| 194 | =head2 MasterUsername => Str | ||
| 195 | |||
| 196 | The master user name for the cluster. | ||
| 197 | |||
| 198 | |||
| 199 | =head2 NodeType => Str | ||
| 200 | |||
| 201 | The node type of the nodes in the cluster. | ||
| 202 | |||
| 203 | |||
| 204 | =head2 NumberOfNodes => Int | ||
| 205 | |||
| 206 | The number of nodes in the cluster. | ||
| 207 | |||
| 208 | |||
| 209 | =head2 OwnerAccount => Str | ||
| 210 | |||
| 211 | For manual snapshots, the AWS customer account used to create or copy | ||
| 212 | the snapshot. For automatic snapshots, the owner of the cluster. The | ||
| 213 | owner can perform all snapshot actions, such as sharing a manual | ||
| 214 | snapshot. | ||
| 215 | |||
| 216 | |||
| 217 | =head2 Port => Int | ||
| 218 | |||
| 219 | The port that the cluster is listening on. | ||
| 220 | |||
| 221 | |||
| 222 | =head2 RestorableNodeTypes => ArrayRef[Str|Undef] | ||
| 223 | |||
| 224 | The list of node types that this cluster snapshot is able to restore | ||
| 225 | into. | ||
| 226 | |||
| 227 | |||
| 228 | =head2 SnapshotCreateTime => Str | ||
| 229 | |||
| 230 | The time (in UTC format) when Amazon Redshift began the snapshot. A | ||
| 231 | snapshot contains a copy of the cluster data as of this exact time. | ||
| 232 | |||
| 233 | |||
| 234 | =head2 SnapshotIdentifier => Str | ||
| 235 | |||
| 236 | The snapshot identifier that is provided in the request. | ||
| 237 | |||
| 238 | |||
| 239 | =head2 SnapshotRetentionStartTime => Str | ||
| 240 | |||
| 241 | A timestamp representing the start of the retention period for the | ||
| 242 | snapshot. | ||
| 243 | |||
| 244 | |||
| 245 | =head2 SnapshotType => Str | ||
| 246 | |||
| 247 | The snapshot type. Snapshots created using CreateClusterSnapshot and | ||
| 248 | CopyClusterSnapshot are of type "manual". | ||
| 249 | |||
| 250 | |||
| 251 | =head2 SourceRegion => Str | ||
| 252 | |||
| 253 | The source region from which the snapshot was copied. | ||
| 254 | |||
| 255 | |||
| 256 | =head2 Status => Str | ||
| 257 | |||
| 258 | The snapshot status. The value of the status depends on the API | ||
| 259 | operation used: | ||
| 260 | |||
| 261 | =over | ||
| 262 | |||
| 263 | =item * | ||
| 264 | |||
| 265 | CreateClusterSnapshot and CopyClusterSnapshot returns status as | ||
| 266 | "creating". | ||
| 267 | |||
| 268 | =item * | ||
| 269 | |||
| 270 | DescribeClusterSnapshots returns status as "creating", "available", | ||
| 271 | "final snapshot", or "failed". | ||
| 272 | |||
| 273 | =item * | ||
| 274 | |||
| 275 | DeleteClusterSnapshot returns status as "deleted". | ||
| 276 | |||
| 277 | =back | ||
| 278 | |||
| 279 | |||
| 280 | |||
| 281 | =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>] | ||
| 282 | |||
| 283 | The list of tags for the cluster snapshot. | ||
| 284 | |||
| 285 | |||
| 286 | =head2 TotalBackupSizeInMegaBytes => Num | ||
| 287 | |||
| 288 | The size of the complete set of backup data that would be used to | ||
| 289 | restore the cluster. | ||
| 290 | |||
| 291 | |||
| 292 | =head2 VpcId => Str | ||
| 293 | |||
| 294 | The VPC identifier of the cluster if the snapshot is from a cluster in | ||
| 295 | a VPC. Otherwise, this field is not in the output. | ||
| 296 | |||
| 297 | |||
| 298 | |||
| 299 | =head1 SEE ALSO | ||
| 300 | |||
| 301 | This class forms part of L<Paws>, describing an object used in L<Paws::RedShift> | ||
| 302 | |||
| 303 | =head1 BUGS and CONTRIBUTIONS | ||
| 304 | |||
| 305 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 306 | |||
| 307 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 308 | |||
| 309 | =cut | ||
| 310 | |||