« blib/lib/Paws/Neptune/RestoreDBClusterFromSnapshotResult.pm
↑ Summary
blib/lib/Paws/Neptune/RestoreDBClusterToPointInTimeResult.pm »
| 1 | |||
| 2 | package Paws::Neptune::RestoreDBClusterToPointInTime; | ||
| 3 | use Moose; | ||
| 4 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has DBClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 6 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 7 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 8 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 10 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 11 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 12 | has Port => (is => 'ro', isa => 'Int'); | ||
| 13 | has RestoreToTime => (is => 'ro', isa => 'Str'); | ||
| 14 | has RestoreType => (is => 'ro', isa => 'Str'); | ||
| 15 | has SourceDBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Tag]'); | ||
| 17 | has UseLatestRestorableTime => (is => 'ro', isa => 'Bool'); | ||
| 18 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 19 | |||
| 20 | use MooseX::ClassAttribute; | ||
| 21 | |||
| 22 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTime'); | ||
| 23 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::RestoreDBClusterToPointInTimeResult'); | ||
| 24 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'RestoreDBClusterToPointInTimeResult'); | ||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::Neptune::RestoreDBClusterToPointInTime - Arguments for method RestoreDBClusterToPointInTime on L<Paws::Neptune> | ||
| 32 | |||
| 33 | =head1 DESCRIPTION | ||
| 34 | |||
| 35 | This class represents the parameters used for calling the method RestoreDBClusterToPointInTime on the | ||
| 36 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 37 | as arguments to method RestoreDBClusterToPointInTime. | ||
| 38 | |||
| 39 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreDBClusterToPointInTime. | ||
| 40 | |||
| 41 | =head1 SYNOPSIS | ||
| 42 | |||
| 43 | my $rds = Paws->service('Neptune'); | ||
| 44 | my $RestoreDBClusterToPointInTimeResult = | ||
| 45 | $rds->RestoreDBClusterToPointInTime( | ||
| 46 | DBClusterIdentifier => 'MyString', | ||
| 47 | SourceDBClusterIdentifier => 'MyString', | ||
| 48 | DBClusterParameterGroupName => 'MyString', # OPTIONAL | ||
| 49 | DBSubnetGroupName => 'MyString', # OPTIONAL | ||
| 50 | DeletionProtection => 1, # OPTIONAL | ||
| 51 | EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL | ||
| 52 | EnableIAMDatabaseAuthentication => 1, # OPTIONAL | ||
| 53 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 54 | OptionGroupName => 'MyString', # OPTIONAL | ||
| 55 | Port => 1, # OPTIONAL | ||
| 56 | RestoreToTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 57 | RestoreType => 'MyString', # OPTIONAL | ||
| 58 | Tags => [ | ||
| 59 | { | ||
| 60 | Key => 'MyString', | ||
| 61 | Value => 'MyString', | ||
| 62 | }, | ||
| 63 | ... | ||
| 64 | ], # OPTIONAL | ||
| 65 | UseLatestRestorableTime => 1, # OPTIONAL | ||
| 66 | VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | # Results: | ||
| 70 | my $DBCluster = $RestoreDBClusterToPointInTimeResult->DBCluster; | ||
| 71 | |||
| 72 | # Returns a L<Paws::Neptune::RestoreDBClusterToPointInTimeResult> object. | ||
| 73 | |||
| 74 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/RestoreDBClusterToPointInTime> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 81 | |||
| 82 | The name of the new DB cluster to be created. | ||
| 83 | |||
| 84 | Constraints: | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | Must contain from 1 to 63 letters, numbers, or hyphens | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | First character must be a letter | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | Cannot end with a hyphen or contain two consecutive hyphens | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DBClusterParameterGroupName => Str | ||
| 106 | |||
| 107 | The name of the DB cluster parameter group to associate with the new DB | ||
| 108 | cluster. | ||
| 109 | |||
| 110 | Constraints: | ||
| 111 | |||
| 112 | =over | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | If supplied, must match the name of an existing | ||
| 117 | DBClusterParameterGroup. | ||
| 118 | |||
| 119 | =back | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 DBSubnetGroupName => Str | ||
| 125 | |||
| 126 | The DB subnet group name to use for the new DB cluster. | ||
| 127 | |||
| 128 | Constraints: If supplied, must match the name of an existing | ||
| 129 | DBSubnetGroup. | ||
| 130 | |||
| 131 | Example: C<mySubnetgroup> | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 DeletionProtection => Bool | ||
| 136 | |||
| 137 | A value that indicates whether the DB cluster has deletion protection | ||
| 138 | enabled. The database can't be deleted when deletion protection is | ||
| 139 | enabled. By default, deletion protection is disabled. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 144 | |||
| 145 | The list of logs that the restored DB cluster is to export to | ||
| 146 | CloudWatch Logs. | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 151 | |||
| 152 | True to enable mapping of Amazon Identity and Access Management (IAM) | ||
| 153 | accounts to database accounts, and otherwise false. | ||
| 154 | |||
| 155 | Default: C<false> | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 KmsKeyId => Str | ||
| 160 | |||
| 161 | The Amazon KMS key identifier to use when restoring an encrypted DB | ||
| 162 | cluster from an encrypted DB cluster. | ||
| 163 | |||
| 164 | The KMS key identifier is the Amazon Resource Name (ARN) for the KMS | ||
| 165 | encryption key. If you are restoring a DB cluster with the same Amazon | ||
| 166 | account that owns the KMS encryption key used to encrypt the new DB | ||
| 167 | cluster, then you can use the KMS key alias instead of the ARN for the | ||
| 168 | KMS encryption key. | ||
| 169 | |||
| 170 | You can restore to a new DB cluster and encrypt the new DB cluster with | ||
| 171 | a KMS key that is different than the KMS key used to encrypt the source | ||
| 172 | DB cluster. The new DB cluster is encrypted with the KMS key identified | ||
| 173 | by the C<KmsKeyId> parameter. | ||
| 174 | |||
| 175 | If you do not specify a value for the C<KmsKeyId> parameter, then the | ||
| 176 | following will occur: | ||
| 177 | |||
| 178 | =over | ||
| 179 | |||
| 180 | =item * | ||
| 181 | |||
| 182 | If the DB cluster is encrypted, then the restored DB cluster is | ||
| 183 | encrypted using the KMS key that was used to encrypt the source DB | ||
| 184 | cluster. | ||
| 185 | |||
| 186 | =item * | ||
| 187 | |||
| 188 | If the DB cluster is not encrypted, then the restored DB cluster is not | ||
| 189 | encrypted. | ||
| 190 | |||
| 191 | =back | ||
| 192 | |||
| 193 | If C<DBClusterIdentifier> refers to a DB cluster that is not encrypted, | ||
| 194 | then the restore request is rejected. | ||
| 195 | |||
| 196 | |||
| 197 | |||
| 198 | =head2 OptionGroupName => Str | ||
| 199 | |||
| 200 | I<(Not supported by Neptune)> | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 Port => Int | ||
| 205 | |||
| 206 | The port number on which the new DB cluster accepts connections. | ||
| 207 | |||
| 208 | Constraints: Value must be C<1150-65535> | ||
| 209 | |||
| 210 | Default: The same port as the original DB cluster. | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head2 RestoreToTime => Str | ||
| 215 | |||
| 216 | The date and time to restore the DB cluster to. | ||
| 217 | |||
| 218 | Valid Values: Value must be a time in Universal Coordinated Time (UTC) | ||
| 219 | format | ||
| 220 | |||
| 221 | Constraints: | ||
| 222 | |||
| 223 | =over | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | Must be before the latest restorable time for the DB instance | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | Must be specified if C<UseLatestRestorableTime> parameter is not | ||
| 232 | provided | ||
| 233 | |||
| 234 | =item * | ||
| 235 | |||
| 236 | Cannot be specified if C<UseLatestRestorableTime> parameter is true | ||
| 237 | |||
| 238 | =item * | ||
| 239 | |||
| 240 | Cannot be specified if C<RestoreType> parameter is C<copy-on-write> | ||
| 241 | |||
| 242 | =back | ||
| 243 | |||
| 244 | Example: C<2015-03-07T23:45:00Z> | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | =head2 RestoreType => Str | ||
| 249 | |||
| 250 | The type of restore to be performed. You can specify one of the | ||
| 251 | following values: | ||
| 252 | |||
| 253 | =over | ||
| 254 | |||
| 255 | =item * | ||
| 256 | |||
| 257 | C<full-copy> - The new DB cluster is restored as a full copy of the | ||
| 258 | source DB cluster. | ||
| 259 | |||
| 260 | =item * | ||
| 261 | |||
| 262 | C<copy-on-write> - The new DB cluster is restored as a clone of the | ||
| 263 | source DB cluster. | ||
| 264 | |||
| 265 | =back | ||
| 266 | |||
| 267 | If you don't specify a C<RestoreType> value, then the new DB cluster is | ||
| 268 | restored as a full copy of the source DB cluster. | ||
| 269 | |||
| 270 | |||
| 271 | |||
| 272 | =head2 B<REQUIRED> SourceDBClusterIdentifier => Str | ||
| 273 | |||
| 274 | The identifier of the source DB cluster from which to restore. | ||
| 275 | |||
| 276 | Constraints: | ||
| 277 | |||
| 278 | =over | ||
| 279 | |||
| 280 | =item * | ||
| 281 | |||
| 282 | Must match the identifier of an existing DBCluster. | ||
| 283 | |||
| 284 | =back | ||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | =head2 Tags => ArrayRef[L<Paws::Neptune::Tag>] | ||
| 290 | |||
| 291 | The tags to be applied to the restored DB cluster. | ||
| 292 | |||
| 293 | |||
| 294 | |||
| 295 | =head2 UseLatestRestorableTime => Bool | ||
| 296 | |||
| 297 | A value that is set to C<true> to restore the DB cluster to the latest | ||
| 298 | restorable backup time, and C<false> otherwise. | ||
| 299 | |||
| 300 | Default: C<false> | ||
| 301 | |||
| 302 | Constraints: Cannot be specified if C<RestoreToTime> parameter is | ||
| 303 | provided. | ||
| 304 | |||
| 305 | |||
| 306 | |||
| 307 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 308 | |||
| 309 | A list of VPC security groups that the new DB cluster belongs to. | ||
| 310 | |||
| 311 | |||
| 312 | |||
| 313 | |||
| 314 | =head1 SEE ALSO | ||
| 315 | |||
| 316 | This class forms part of L<Paws>, documenting arguments for method RestoreDBClusterToPointInTime in L<Paws::Neptune> | ||
| 317 | |||
| 318 | =head1 BUGS and CONTRIBUTIONS | ||
| 319 | |||
| 320 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 321 | |||
| 322 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 323 | |||
| 324 | =cut | ||
| 325 |