« blib/lib/Paws/Neptune/DBEngineVersionMessage.pm
↑ Summary
blib/lib/Paws/Neptune/DBInstanceMessage.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Neptune::DBInstance; | ||
| 3 | use Moose; | ||
| 4 | has AllocatedStorage => (is => 'ro', isa => 'Int'); | ||
| 5 | has AutoMinorVersionUpgrade => (is => 'ro', isa => 'Bool'); | ||
| 6 | has AvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 7 | has BackupRetentionPeriod => (is => 'ro', isa => 'Int'); | ||
| 8 | has CACertificateIdentifier => (is => 'ro', isa => 'Str'); | ||
| 9 | has CharacterSetName => (is => 'ro', isa => 'Str'); | ||
| 10 | has CopyTagsToSnapshot => (is => 'ro', isa => 'Bool'); | ||
| 11 | has DBClusterIdentifier => (is => 'ro', isa => 'Str'); | ||
| 12 | has DBInstanceArn => (is => 'ro', isa => 'Str'); | ||
| 13 | has DBInstanceClass => (is => 'ro', isa => 'Str'); | ||
| 14 | has DBInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 15 | has DbInstancePort => (is => 'ro', isa => 'Int'); | ||
| 16 | has DBInstanceStatus => (is => 'ro', isa => 'Str'); | ||
| 17 | has DbiResourceId => (is => 'ro', isa => 'Str'); | ||
| 18 | has DBName => (is => 'ro', isa => 'Str'); | ||
| 19 | has DBParameterGroups => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::DBParameterGroupStatus]', request_name => 'DBParameterGroup', traits => ['NameInRequest']); | ||
| 20 | has DBSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::DBSecurityGroupMembership]', request_name => 'DBSecurityGroup', traits => ['NameInRequest']); | ||
| 21 | has DBSubnetGroup => (is => 'ro', isa => 'Paws::Neptune::DBSubnetGroup'); | ||
| 22 | has DeletionProtection => (is => 'ro', isa => 'Bool'); | ||
| 23 | has DomainMemberships => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::DomainMembership]', request_name => 'DomainMembership', traits => ['NameInRequest']); | ||
| 24 | has EnabledCloudwatchLogsExports => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 25 | has Endpoint => (is => 'ro', isa => 'Paws::Neptune::Endpoint'); | ||
| 26 | has Engine => (is => 'ro', isa => 'Str'); | ||
| 27 | has EngineVersion => (is => 'ro', isa => 'Str'); | ||
| 28 | has EnhancedMonitoringResourceArn => (is => 'ro', isa => 'Str'); | ||
| 29 | has IAMDatabaseAuthenticationEnabled => (is => 'ro', isa => 'Bool'); | ||
| 30 | has InstanceCreateTime => (is => 'ro', isa => 'Str'); | ||
| 31 | has Iops => (is => 'ro', isa => 'Int'); | ||
| 32 | has KmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 33 | has LatestRestorableTime => (is => 'ro', isa => 'Str'); | ||
| 34 | has LicenseModel => (is => 'ro', isa => 'Str'); | ||
| 35 | has MasterUsername => (is => 'ro', isa => 'Str'); | ||
| 36 | has MonitoringInterval => (is => 'ro', isa => 'Int'); | ||
| 37 | has MonitoringRoleArn => (is => 'ro', isa => 'Str'); | ||
| 38 | has MultiAZ => (is => 'ro', isa => 'Bool'); | ||
| 39 | has OptionGroupMemberships => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::OptionGroupMembership]', request_name => 'OptionGroupMembership', traits => ['NameInRequest']); | ||
| 40 | has PendingModifiedValues => (is => 'ro', isa => 'Paws::Neptune::PendingModifiedValues'); | ||
| 41 | has PerformanceInsightsEnabled => (is => 'ro', isa => 'Bool'); | ||
| 42 | has PerformanceInsightsKMSKeyId => (is => 'ro', isa => 'Str'); | ||
| 43 | has PreferredBackupWindow => (is => 'ro', isa => 'Str'); | ||
| 44 | has PreferredMaintenanceWindow => (is => 'ro', isa => 'Str'); | ||
| 45 | has PromotionTier => (is => 'ro', isa => 'Int'); | ||
| 46 | has PubliclyAccessible => (is => 'ro', isa => 'Bool'); | ||
| 47 | has ReadReplicaDBClusterIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaDBClusterIdentifier', traits => ['NameInRequest']); | ||
| 48 | has ReadReplicaDBInstanceIdentifiers => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ReadReplicaDBInstanceIdentifier', traits => ['NameInRequest']); | ||
| 49 | has ReadReplicaSourceDBInstanceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 50 | has SecondaryAvailabilityZone => (is => 'ro', isa => 'Str'); | ||
| 51 | has StatusInfos => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::DBInstanceStatusInfo]', request_name => 'DBInstanceStatusInfo', traits => ['NameInRequest']); | ||
| 52 | has StorageEncrypted => (is => 'ro', isa => 'Bool'); | ||
| 53 | has StorageType => (is => 'ro', isa => 'Str'); | ||
| 54 | has TdeCredentialArn => (is => 'ro', isa => 'Str'); | ||
| 55 | has Timezone => (is => 'ro', isa => 'Str'); | ||
| 56 | has VpcSecurityGroups => (is => 'ro', isa => 'ArrayRef[Paws::Neptune::VpcSecurityGroupMembership]', request_name => 'VpcSecurityGroupMembership', traits => ['NameInRequest']); | ||
| 57 | |||
| 58 | 1; | ||
| 59 | |||
| 60 | ### main pod documentation begin ### | ||
| 61 | |||
| 62 | =head1 NAME | ||
| 63 | |||
| 64 | Paws::Neptune::DBInstance | ||
| 65 | |||
| 66 | =head1 USAGE | ||
| 67 | |||
| 68 | This class represents one of two things: | ||
| 69 | |||
| 70 | =head3 Arguments in a call to a service | ||
| 71 | |||
| 72 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 73 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 74 | |||
| 75 | As an example, if Att1 is expected to be a Paws::Neptune::DBInstance object: | ||
| 76 | |||
| 77 | $service_obj->Method(Att1 => { AllocatedStorage => $value, ..., VpcSecurityGroups => $value }); | ||
| 78 | |||
| 79 | =head3 Results returned from an API call | ||
| 80 | |||
| 81 | Use accessors for each attribute. If Att1 is expected to be an Paws::Neptune::DBInstance object: | ||
| 82 | |||
| 83 | $result = $service_obj->Method(...); | ||
| 84 | $result->Att1->AllocatedStorage | ||
| 85 | |||
| 86 | =head1 DESCRIPTION | ||
| 87 | |||
| 88 | Contains the details of an Amazon Neptune DB instance. | ||
| 89 | |||
| 90 | This data type is used as a response element in the DescribeDBInstances | ||
| 91 | action. | ||
| 92 | |||
| 93 | =head1 ATTRIBUTES | ||
| 94 | |||
| 95 | |||
| 96 | =head2 AllocatedStorage => Int | ||
| 97 | |||
| 98 | Not supported by Neptune. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 AutoMinorVersionUpgrade => Bool | ||
| 102 | |||
| 103 | Indicates that minor version patches are applied automatically. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 AvailabilityZone => Str | ||
| 107 | |||
| 108 | Specifies the name of the Availability Zone the DB instance is located | ||
| 109 | in. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 BackupRetentionPeriod => Int | ||
| 113 | |||
| 114 | Specifies the number of days for which automatic DB snapshots are | ||
| 115 | retained. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 CACertificateIdentifier => Str | ||
| 119 | |||
| 120 | The identifier of the CA certificate for this DB instance. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 CharacterSetName => Str | ||
| 124 | |||
| 125 | I<(Not supported by Neptune)> | ||
| 126 | |||
| 127 | |||
| 128 | =head2 CopyTagsToSnapshot => Bool | ||
| 129 | |||
| 130 | Specifies whether tags are copied from the DB instance to snapshots of | ||
| 131 | the DB instance. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 DBClusterIdentifier => Str | ||
| 135 | |||
| 136 | If the DB instance is a member of a DB cluster, contains the name of | ||
| 137 | the DB cluster that the DB instance is a member of. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 DBInstanceArn => Str | ||
| 141 | |||
| 142 | The Amazon Resource Name (ARN) for the DB instance. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 DBInstanceClass => Str | ||
| 146 | |||
| 147 | Contains the name of the compute and memory capacity class of the DB | ||
| 148 | instance. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 DBInstanceIdentifier => Str | ||
| 152 | |||
| 153 | Contains a user-supplied database identifier. This identifier is the | ||
| 154 | unique key that identifies a DB instance. | ||
| 155 | |||
| 156 | |||
| 157 | =head2 DbInstancePort => Int | ||
| 158 | |||
| 159 | Specifies the port that the DB instance listens on. If the DB instance | ||
| 160 | is part of a DB cluster, this can be a different port than the DB | ||
| 161 | cluster port. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 DBInstanceStatus => Str | ||
| 165 | |||
| 166 | Specifies the current state of this database. | ||
| 167 | |||
| 168 | |||
| 169 | =head2 DbiResourceId => Str | ||
| 170 | |||
| 171 | The Amazon Region-unique, immutable identifier for the DB instance. | ||
| 172 | This identifier is found in Amazon CloudTrail log entries whenever the | ||
| 173 | Amazon KMS key for the DB instance is accessed. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 DBName => Str | ||
| 177 | |||
| 178 | The database name. | ||
| 179 | |||
| 180 | |||
| 181 | =head2 DBParameterGroups => ArrayRef[L<Paws::Neptune::DBParameterGroupStatus>] | ||
| 182 | |||
| 183 | Provides the list of DB parameter groups applied to this DB instance. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 DBSecurityGroups => ArrayRef[L<Paws::Neptune::DBSecurityGroupMembership>] | ||
| 187 | |||
| 188 | Provides List of DB security group elements containing only | ||
| 189 | C<DBSecurityGroup.Name> and C<DBSecurityGroup.Status> subelements. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 DBSubnetGroup => L<Paws::Neptune::DBSubnetGroup> | ||
| 193 | |||
| 194 | Specifies information on the subnet group associated with the DB | ||
| 195 | instance, including the name, description, and subnets in the subnet | ||
| 196 | group. | ||
| 197 | |||
| 198 | |||
| 199 | =head2 DeletionProtection => Bool | ||
| 200 | |||
| 201 | Indicates whether or not the DB instance has deletion protection | ||
| 202 | enabled. The instance can't be deleted when deletion protection is | ||
| 203 | enabled. See Deleting a DB Instance | ||
| 204 | (https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). | ||
| 205 | |||
| 206 | |||
| 207 | =head2 DomainMemberships => ArrayRef[L<Paws::Neptune::DomainMembership>] | ||
| 208 | |||
| 209 | Not supported | ||
| 210 | |||
| 211 | |||
| 212 | =head2 EnabledCloudwatchLogsExports => ArrayRef[Str|Undef] | ||
| 213 | |||
| 214 | A list of log types that this DB instance is configured to export to | ||
| 215 | CloudWatch Logs. | ||
| 216 | |||
| 217 | |||
| 218 | =head2 Endpoint => L<Paws::Neptune::Endpoint> | ||
| 219 | |||
| 220 | Specifies the connection endpoint. | ||
| 221 | |||
| 222 | |||
| 223 | =head2 Engine => Str | ||
| 224 | |||
| 225 | Provides the name of the database engine to be used for this DB | ||
| 226 | instance. | ||
| 227 | |||
| 228 | |||
| 229 | =head2 EngineVersion => Str | ||
| 230 | |||
| 231 | Indicates the database engine version. | ||
| 232 | |||
| 233 | |||
| 234 | =head2 EnhancedMonitoringResourceArn => Str | ||
| 235 | |||
| 236 | The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream | ||
| 237 | that receives the Enhanced Monitoring metrics data for the DB instance. | ||
| 238 | |||
| 239 | |||
| 240 | =head2 IAMDatabaseAuthenticationEnabled => Bool | ||
| 241 | |||
| 242 | True if Amazon Identity and Access Management (IAM) authentication is | ||
| 243 | enabled, and otherwise false. | ||
| 244 | |||
| 245 | |||
| 246 | =head2 InstanceCreateTime => Str | ||
| 247 | |||
| 248 | Provides the date and time the DB instance was created. | ||
| 249 | |||
| 250 | |||
| 251 | =head2 Iops => Int | ||
| 252 | |||
| 253 | Specifies the Provisioned IOPS (I/O operations per second) value. | ||
| 254 | |||
| 255 | |||
| 256 | =head2 KmsKeyId => Str | ||
| 257 | |||
| 258 | Not supported: The encryption for DB instances is managed by the DB | ||
| 259 | cluster. | ||
| 260 | |||
| 261 | |||
| 262 | =head2 LatestRestorableTime => Str | ||
| 263 | |||
| 264 | Specifies the latest time to which a database can be restored with | ||
| 265 | point-in-time restore. | ||
| 266 | |||
| 267 | |||
| 268 | =head2 LicenseModel => Str | ||
| 269 | |||
| 270 | License model information for this DB instance. | ||
| 271 | |||
| 272 | |||
| 273 | =head2 MasterUsername => Str | ||
| 274 | |||
| 275 | Not supported by Neptune. | ||
| 276 | |||
| 277 | |||
| 278 | =head2 MonitoringInterval => Int | ||
| 279 | |||
| 280 | The interval, in seconds, between points when Enhanced Monitoring | ||
| 281 | metrics are collected for the DB instance. | ||
| 282 | |||
| 283 | |||
| 284 | =head2 MonitoringRoleArn => Str | ||
| 285 | |||
| 286 | The ARN for the IAM role that permits Neptune to send Enhanced | ||
| 287 | Monitoring metrics to Amazon CloudWatch Logs. | ||
| 288 | |||
| 289 | |||
| 290 | =head2 MultiAZ => Bool | ||
| 291 | |||
| 292 | Specifies if the DB instance is a Multi-AZ deployment. | ||
| 293 | |||
| 294 | |||
| 295 | =head2 OptionGroupMemberships => ArrayRef[L<Paws::Neptune::OptionGroupMembership>] | ||
| 296 | |||
| 297 | I<(Not supported by Neptune)> | ||
| 298 | |||
| 299 | |||
| 300 | =head2 PendingModifiedValues => L<Paws::Neptune::PendingModifiedValues> | ||
| 301 | |||
| 302 | Specifies that changes to the DB instance are pending. This element is | ||
| 303 | only included when changes are pending. Specific changes are identified | ||
| 304 | by subelements. | ||
| 305 | |||
| 306 | |||
| 307 | =head2 PerformanceInsightsEnabled => Bool | ||
| 308 | |||
| 309 | I<(Not supported by Neptune)> | ||
| 310 | |||
| 311 | |||
| 312 | =head2 PerformanceInsightsKMSKeyId => Str | ||
| 313 | |||
| 314 | I<(Not supported by Neptune)> | ||
| 315 | |||
| 316 | |||
| 317 | =head2 PreferredBackupWindow => Str | ||
| 318 | |||
| 319 | Specifies the daily time range during which automated backups are | ||
| 320 | created if automated backups are enabled, as determined by the | ||
| 321 | C<BackupRetentionPeriod>. | ||
| 322 | |||
| 323 | |||
| 324 | =head2 PreferredMaintenanceWindow => Str | ||
| 325 | |||
| 326 | Specifies the weekly time range during which system maintenance can | ||
| 327 | occur, in Universal Coordinated Time (UTC). | ||
| 328 | |||
| 329 | |||
| 330 | =head2 PromotionTier => Int | ||
| 331 | |||
| 332 | A value that specifies the order in which a Read Replica is promoted to | ||
| 333 | the primary instance after a failure of the existing primary instance. | ||
| 334 | |||
| 335 | |||
| 336 | =head2 PubliclyAccessible => Bool | ||
| 337 | |||
| 338 | This flag should no longer be used. | ||
| 339 | |||
| 340 | |||
| 341 | =head2 ReadReplicaDBClusterIdentifiers => ArrayRef[Str|Undef] | ||
| 342 | |||
| 343 | Contains one or more identifiers of DB clusters that are Read Replicas | ||
| 344 | of this DB instance. | ||
| 345 | |||
| 346 | |||
| 347 | =head2 ReadReplicaDBInstanceIdentifiers => ArrayRef[Str|Undef] | ||
| 348 | |||
| 349 | Contains one or more identifiers of the Read Replicas associated with | ||
| 350 | this DB instance. | ||
| 351 | |||
| 352 | |||
| 353 | =head2 ReadReplicaSourceDBInstanceIdentifier => Str | ||
| 354 | |||
| 355 | Contains the identifier of the source DB instance if this DB instance | ||
| 356 | is a Read Replica. | ||
| 357 | |||
| 358 | |||
| 359 | =head2 SecondaryAvailabilityZone => Str | ||
| 360 | |||
| 361 | If present, specifies the name of the secondary Availability Zone for a | ||
| 362 | DB instance with multi-AZ support. | ||
| 363 | |||
| 364 | |||
| 365 | =head2 StatusInfos => ArrayRef[L<Paws::Neptune::DBInstanceStatusInfo>] | ||
| 366 | |||
| 367 | The status of a Read Replica. If the instance is not a Read Replica, | ||
| 368 | this is blank. | ||
| 369 | |||
| 370 | |||
| 371 | =head2 StorageEncrypted => Bool | ||
| 372 | |||
| 373 | Not supported: The encryption for DB instances is managed by the DB | ||
| 374 | cluster. | ||
| 375 | |||
| 376 | |||
| 377 | =head2 StorageType => Str | ||
| 378 | |||
| 379 | Specifies the storage type associated with DB instance. | ||
| 380 | |||
| 381 | |||
| 382 | =head2 TdeCredentialArn => Str | ||
| 383 | |||
| 384 | The ARN from the key store with which the instance is associated for | ||
| 385 | TDE encryption. | ||
| 386 | |||
| 387 | |||
| 388 | =head2 Timezone => Str | ||
| 389 | |||
| 390 | Not supported. | ||
| 391 | |||
| 392 | |||
| 393 | =head2 VpcSecurityGroups => ArrayRef[L<Paws::Neptune::VpcSecurityGroupMembership>] | ||
| 394 | |||
| 395 | Provides a list of VPC security group elements that the DB instance | ||
| 396 | belongs to. | ||
| 397 | |||
| 398 | |||
| 399 | |||
| 400 | =head1 SEE ALSO | ||
| 401 | |||
| 402 | This class forms part of L<Paws>, describing an object used in L<Paws::Neptune> | ||
| 403 | |||
| 404 | =head1 BUGS and CONTRIBUTIONS | ||
| 405 | |||
| 406 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 407 | |||
| 408 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 409 | |||
| 410 | =cut | ||
| 411 |