« blib/lib/Paws/Neptune/CopyDBParameterGroupResult.pm
↑ Summary
blib/lib/Paws/Neptune/CreateDBClusterEndpoint.pm »
| 1 | |||
| 2 | package Paws::Neptune::CreateDBCluster; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZones => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 6 | has CharacterSetName => (is => 'ro', isa => 'Str'); | ||
| 7 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 8 | has DatabaseName => (is => 'ro', isa => 'Str'); | ||
| 9 | has DBClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has DBClusterParameterGroupName => (is => 'ro', isa => 'Str'); | ||
| 11 | has DBSubnetGroupName => (is => 'ro', isa => 'Str'); | ||
| 12 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 13 | has EnableCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 14 | has EnableIAMDatabaseAuthentication => (is => 'ro', isa => 'Bool'); | ||
| 15 | has Engine => (is => 'ro', isa => 'Str', required => 1); | ||
| 16 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 17 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 18 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 19 | has MasterUserPassword => (is => 'ro', isa => 'Str'); | ||
| 20 | has OptionGroupName => (is => 'ro', isa => 'Str'); | ||
| 21 | has Port => (is => 'ro', isa => 'Int'); | ||
| 22 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 23 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 24 | has PreSignedUrl => (is => 'ro', isa => 'Str'); | ||
| 25 | has ReplicationSourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 26 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 27 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::Tag]'); | ||
| 28 | has VpcSecurityGroupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 29 | |||
| 30 | use MooseX::ClassAttribute; | ||
| 31 | |||
| 32 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDBCluster'); | ||
| 33 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Neptune::CreateDBClusterResult'); | ||
| 34 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateDBClusterResult'); | ||
| 35 | 1; | ||
| 36 | |||
| 37 | ### main pod documentation begin ### | ||
| 38 | |||
| 39 | =head1 NAME | ||
| 40 | |||
| 41 | Paws::Neptune::CreateDBCluster - Arguments for method CreateDBCluster on L<Paws::Neptune> | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | This class represents the parameters used for calling the method CreateDBCluster on the | ||
| 46 | L<Amazon Neptune|Paws::Neptune> service. Use the attributes of this class | ||
| 47 | as arguments to method CreateDBCluster. | ||
| 48 | |||
| 49 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDBCluster. | ||
| 50 | |||
| 51 | =head1 SYNOPSIS | ||
| 52 | |||
| 53 | my $rds = Paws->service('Neptune'); | ||
| 54 | my $CreateDBClusterResult = $rds->CreateDBCluster( | ||
| 55 | DBClusterIdentifier => 'MyString', | ||
| 56 | Engine => 'MyString', | ||
| 57 | AvailabilityZones => [ 'MyString', ... ], # OPTIONAL | ||
| 58 | BackupRetentionPeriod => 1, # OPTIONAL | ||
| 59 | CharacterSetName => 'MyString', # OPTIONAL | ||
| 60 | CopyTagsToSnapshot => 1, # OPTIONAL | ||
| 61 | DBClusterParameterGroupName => 'MyString', # OPTIONAL | ||
| 62 | DBSubnetGroupName => 'MyString', # OPTIONAL | ||
| 63 | DatabaseName => 'MyString', # OPTIONAL | ||
| 64 | DeletionProtection => 1, # OPTIONAL | ||
| 65 | EnableCloudwatchLogsExports => [ 'MyString', ... ], # OPTIONAL | ||
| 66 | EnableIAMDatabaseAuthentication => 1, # OPTIONAL | ||
| 67 | EngineVersion => 'MyString', # OPTIONAL | ||
| 68 | KmsKeyId => 'MyString', # OPTIONAL | ||
| 69 | MasterUserPassword => 'MyString', # OPTIONAL | ||
| 70 | MasterUsername => 'MyString', # OPTIONAL | ||
| 71 | OptionGroupName => 'MyString', # OPTIONAL | ||
| 72 | Port => 1, # OPTIONAL | ||
| 73 | PreSignedUrl => 'MyString', # OPTIONAL | ||
| 74 | PreferredBackupWindow => 'MyString', # OPTIONAL | ||
| 75 | PreferredMaintenanceWindow => 'MyString', # OPTIONAL | ||
| 76 | ReplicationSourceIdentifier => 'MyString', # OPTIONAL | ||
| 77 | StorageEncrypted => 1, # OPTIONAL | ||
| 78 | Tags => [ | ||
| 79 | { | ||
| 80 | Key => 'MyString', | ||
| 81 | Value => 'MyString', | ||
| 82 | }, | ||
| 83 | ... | ||
| 84 | ], # OPTIONAL | ||
| 85 | VpcSecurityGroupIds => [ 'MyString', ... ], # OPTIONAL | ||
| 86 | ); | ||
| 87 | |||
| 88 | # Results: | ||
| 89 | my $DBCluster = $CreateDBClusterResult->DBCluster; | ||
| 90 | |||
| 91 | # Returns a L<Paws::Neptune::CreateDBClusterResult> object. | ||
| 92 | |||
| 93 | 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. | ||
| 94 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/CreateDBCluster> | ||
| 95 | |||
| 96 | =head1 ATTRIBUTES | ||
| 97 | |||
| 98 | |||
| 99 | =head2 AvailabilityZones => ArrayRef[Str|Undef] | ||
| 100 | |||
| 101 | A list of EC2 Availability Zones that instances in the DB cluster can | ||
| 102 | be created in. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 BackupRetentionPeriod => Int | ||
| 107 | |||
| 108 | The number of days for which automated backups are retained. You must | ||
| 109 | specify a minimum value of 1. | ||
| 110 | |||
| 111 | Default: 1 | ||
| 112 | |||
| 113 | Constraints: | ||
| 114 | |||
| 115 | =over | ||
| 116 | |||
| 117 | =item * | ||
| 118 | |||
| 119 | Must be a value from 1 to 35 | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 CharacterSetName => Str | ||
| 127 | |||
| 128 | I<(Not supported by Neptune)> | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | =head2 CopyTagsToSnapshot => Bool | ||
| 133 | |||
| 134 | I<If set to C<true>, tags are copied to any snapshot of the DB cluster | ||
| 135 | that is created.> | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 DatabaseName => Str | ||
| 140 | |||
| 141 | The name for your database of up to 64 alpha-numeric characters. If you | ||
| 142 | do not provide a name, Amazon Neptune will not create a database in the | ||
| 143 | DB cluster you are creating. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 B<REQUIRED> DBClusterIdentifier => Str | ||
| 148 | |||
| 149 | The DB cluster identifier. This parameter is stored as a lowercase | ||
| 150 | string. | ||
| 151 | |||
| 152 | Constraints: | ||
| 153 | |||
| 154 | =over | ||
| 155 | |||
| 156 | =item * | ||
| 157 | |||
| 158 | Must contain from 1 to 63 letters, numbers, or hyphens. | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | First character must be a letter. | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | Cannot end with a hyphen or contain two consecutive hyphens. | ||
| 167 | |||
| 168 | =back | ||
| 169 | |||
| 170 | Example: C<my-cluster1> | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 DBClusterParameterGroupName => Str | ||
| 175 | |||
| 176 | The name of the DB cluster parameter group to associate with this DB | ||
| 177 | cluster. If this argument is omitted, the default is used. | ||
| 178 | |||
| 179 | Constraints: | ||
| 180 | |||
| 181 | =over | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | If supplied, must match the name of an existing | ||
| 186 | DBClusterParameterGroup. | ||
| 187 | |||
| 188 | =back | ||
| 189 | |||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | =head2 DBSubnetGroupName => Str | ||
| 194 | |||
| 195 | A DB subnet group to associate with this DB cluster. | ||
| 196 | |||
| 197 | Constraints: Must match the name of an existing DBSubnetGroup. Must not | ||
| 198 | be default. | ||
| 199 | |||
| 200 | Example: C<mySubnetgroup> | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 DeletionProtection => Bool | ||
| 205 | |||
| 206 | A value that indicates whether the DB cluster has deletion protection | ||
| 207 | enabled. The database can't be deleted when deletion protection is | ||
| 208 | enabled. By default, deletion protection is enabled. | ||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | =head2 EnableCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 213 | |||
| 214 | The list of log types that need to be enabled for exporting to | ||
| 215 | CloudWatch Logs. | ||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | =head2 EnableIAMDatabaseAuthentication => Bool | ||
| 220 | |||
| 221 | If set to C<true>, enables Amazon Identity and Access Management (IAM) | ||
| 222 | authentication for the entire DB cluster (this cannot be set at an | ||
| 223 | instance level). | ||
| 224 | |||
| 225 | Default: C<false>. | ||
| 226 | |||
| 227 | |||
| 228 | |||
| 229 | =head2 B<REQUIRED> Engine => Str | ||
| 230 | |||
| 231 | The name of the database engine to be used for this DB cluster. | ||
| 232 | |||
| 233 | Valid Values: C<neptune> | ||
| 234 | |||
| 235 | |||
| 236 | |||
| 237 | =head2 EngineVersion => Str | ||
| 238 | |||
| 239 | The version number of the database engine to use for the new DB | ||
| 240 | cluster. | ||
| 241 | |||
| 242 | Example: C<1.0.2.1> | ||
| 243 | |||
| 244 | |||
| 245 | |||
| 246 | =head2 KmsKeyId => Str | ||
| 247 | |||
| 248 | The Amazon KMS key identifier for an encrypted DB cluster. | ||
| 249 | |||
| 250 | The KMS key identifier is the Amazon Resource Name (ARN) for the KMS | ||
| 251 | encryption key. If you are creating a DB cluster with the same Amazon | ||
| 252 | account that owns the KMS encryption key used to encrypt the new DB | ||
| 253 | cluster, then you can use the KMS key alias instead of the ARN for the | ||
| 254 | KMS encryption key. | ||
| 255 | |||
| 256 | If an encryption key is not specified in C<KmsKeyId>: | ||
| 257 | |||
| 258 | =over | ||
| 259 | |||
| 260 | =item * | ||
| 261 | |||
| 262 | If C<ReplicationSourceIdentifier> identifies an encrypted source, then | ||
| 263 | Amazon Neptune will use the encryption key used to encrypt the source. | ||
| 264 | Otherwise, Amazon Neptune will use your default encryption key. | ||
| 265 | |||
| 266 | =item * | ||
| 267 | |||
| 268 | If the C<StorageEncrypted> parameter is true and | ||
| 269 | C<ReplicationSourceIdentifier> is not specified, then Amazon Neptune | ||
| 270 | will use your default encryption key. | ||
| 271 | |||
| 272 | =back | ||
| 273 | |||
| 274 | Amazon KMS creates the default encryption key for your Amazon account. | ||
| 275 | Your Amazon account has a different default encryption key for each | ||
| 276 | Amazon Region. | ||
| 277 | |||
| 278 | If you create a Read Replica of an encrypted DB cluster in another | ||
| 279 | Amazon Region, you must set C<KmsKeyId> to a KMS key ID that is valid | ||
| 280 | in the destination Amazon Region. This key is used to encrypt the Read | ||
| 281 | Replica in that Amazon Region. | ||
| 282 | |||
| 283 | |||
| 284 | |||
| 285 | =head2 MasterUsername => Str | ||
| 286 | |||
| 287 | Not supported by Neptune. | ||
| 288 | |||
| 289 | |||
| 290 | |||
| 291 | =head2 MasterUserPassword => Str | ||
| 292 | |||
| 293 | Not supported by Neptune. | ||
| 294 | |||
| 295 | |||
| 296 | |||
| 297 | =head2 OptionGroupName => Str | ||
| 298 | |||
| 299 | I<(Not supported by Neptune)> | ||
| 300 | |||
| 301 | |||
| 302 | |||
| 303 | =head2 Port => Int | ||
| 304 | |||
| 305 | The port number on which the instances in the DB cluster accept | ||
| 306 | connections. | ||
| 307 | |||
| 308 | Default: C<8182> | ||
| 309 | |||
| 310 | |||
| 311 | |||
| 312 | =head2 PreferredBackupWindow => Str | ||
| 313 | |||
| 314 | The daily time range during which automated backups are created if | ||
| 315 | automated backups are enabled using the C<BackupRetentionPeriod> | ||
| 316 | parameter. | ||
| 317 | |||
| 318 | The default is a 30-minute window selected at random from an 8-hour | ||
| 319 | block of time for each Amazon Region. To see the time blocks available, | ||
| 320 | see Adjusting the Preferred Maintenance Window | ||
| 321 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) | ||
| 322 | in the I<Amazon Neptune User Guide.> | ||
| 323 | |||
| 324 | Constraints: | ||
| 325 | |||
| 326 | =over | ||
| 327 | |||
| 328 | =item * | ||
| 329 | |||
| 330 | Must be in the format C<hh24:mi-hh24:mi>. | ||
| 331 | |||
| 332 | =item * | ||
| 333 | |||
| 334 | Must be in Universal Coordinated Time (UTC). | ||
| 335 | |||
| 336 | =item * | ||
| 337 | |||
| 338 | Must not conflict with the preferred maintenance window. | ||
| 339 | |||
| 340 | =item * | ||
| 341 | |||
| 342 | Must be at least 30 minutes. | ||
| 343 | |||
| 344 | =back | ||
| 345 | |||
| 346 | |||
| 347 | |||
| 348 | |||
| 349 | =head2 PreferredMaintenanceWindow => Str | ||
| 350 | |||
| 351 | The weekly time range during which system maintenance can occur, in | ||
| 352 | Universal Coordinated Time (UTC). | ||
| 353 | |||
| 354 | Format: C<ddd:hh24:mi-ddd:hh24:mi> | ||
| 355 | |||
| 356 | The default is a 30-minute window selected at random from an 8-hour | ||
| 357 | block of time for each Amazon Region, occurring on a random day of the | ||
| 358 | week. To see the time blocks available, see Adjusting the Preferred | ||
| 359 | Maintenance Window | ||
| 360 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html) | ||
| 361 | in the I<Amazon Neptune User Guide.> | ||
| 362 | |||
| 363 | Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. | ||
| 364 | |||
| 365 | Constraints: Minimum 30-minute window. | ||
| 366 | |||
| 367 | |||
| 368 | |||
| 369 | =head2 PreSignedUrl => Str | ||
| 370 | |||
| 371 | This parameter is not currently supported. | ||
| 372 | |||
| 373 | |||
| 374 | |||
| 375 | =head2 ReplicationSourceIdentifier => Str | ||
| 376 | |||
| 377 | The Amazon Resource Name (ARN) of the source DB instance or DB cluster | ||
| 378 | if this DB cluster is created as a Read Replica. | ||
| 379 | |||
| 380 | |||
| 381 | |||
| 382 | =head2 StorageEncrypted => Bool | ||
| 383 | |||
| 384 | Specifies whether the DB cluster is encrypted. | ||
| 385 | |||
| 386 | |||
| 387 | |||
| 388 | =head2 Tags => ArrayRef[L<Paws::Neptune::Tag>] | ||
| 389 | |||
| 390 | The tags to assign to the new DB cluster. | ||
| 391 | |||
| 392 | |||
| 393 | |||
| 394 | =head2 VpcSecurityGroupIds => ArrayRef[Str|Undef] | ||
| 395 | |||
| 396 | A list of EC2 VPC security groups to associate with this DB cluster. | ||
| 397 | |||
| 398 | |||
| 399 | |||
| 400 | |||
| 401 | =head1 SEE ALSO | ||
| 402 | |||
| 403 | This class forms part of L<Paws>, documenting arguments for method CreateDBCluster in L<Paws::Neptune> | ||
| 404 | |||
| 405 | =head1 BUGS and CONTRIBUTIONS | ||
| 406 | |||
| 407 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 408 | |||
| 409 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 410 | |||
| 411 | =cut | ||
| 412 |