1// Code generated by smithy-go-codegen DO NOT EDIT. 2 3package types 4 5import ( 6 "time" 7) 8 9// Describes a quota for an AWS account. The following are account quotas: 10// 11// * 12// AllocatedStorage - The total allocated storage per account, in GiB. The used 13// value is the total allocated storage in the account, in GiB. 14// 15// * 16// AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security 17// group. The used value is the highest number of ingress rules in a DB security 18// group in the account. Other DB security groups in the account might have a lower 19// number of ingress rules. 20// 21// * CustomEndpointsPerDBCluster - The number of custom 22// endpoints per DB cluster. The used value is the highest number of custom 23// endpoints in a DB clusters in the account. Other DB clusters in the account 24// might have a lower number of custom endpoints. 25// 26// * DBClusterParameterGroups - The 27// number of DB cluster parameter groups per account, excluding default parameter 28// groups. The used value is the count of nondefault DB cluster parameter groups in 29// the account. 30// 31// * DBClusterRoles - The number of associated AWS Identity and 32// Access Management (IAM) roles per DB cluster. The used value is the highest 33// number of associated IAM roles for a DB cluster in the account. Other DB 34// clusters in the account might have a lower number of associated IAM roles. 35// 36// * 37// DBClusters - The number of DB clusters per account. The used value is the count 38// of DB clusters in the account. 39// 40// * DBInstanceRoles - The number of associated IAM 41// roles per DB instance. The used value is the highest number of associated IAM 42// roles for a DB instance in the account. Other DB instances in the account might 43// have a lower number of associated IAM roles. 44// 45// * DBInstances - The number of DB 46// instances per account. The used value is the count of the DB instances in the 47// account. Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune 48// instances, and Amazon DocumentDB instances apply to this quota. 49// 50// * 51// DBParameterGroups - The number of DB parameter groups per account, excluding 52// default parameter groups. The used value is the count of nondefault DB parameter 53// groups in the account. 54// 55// * DBSecurityGroups - The number of DB security groups 56// (not VPC security groups) per account, excluding the default security group. The 57// used value is the count of nondefault DB security groups in the account. 58// 59// * 60// DBSubnetGroups - The number of DB subnet groups per account. The used value is 61// the count of the DB subnet groups in the account. 62// 63// * EventSubscriptions - The 64// number of event subscriptions per account. The used value is the count of the 65// event subscriptions in the account. 66// 67// * ManualClusterSnapshots - The number of 68// manual DB cluster snapshots per account. The used value is the count of the 69// manual DB cluster snapshots in the account. 70// 71// * ManualSnapshots - The number of 72// manual DB instance snapshots per account. The used value is the count of the 73// manual DB instance snapshots in the account. 74// 75// * OptionGroups - The number of DB 76// option groups per account, excluding default option groups. The used value is 77// the count of nondefault DB option groups in the account. 78// 79// * 80// ReadReplicasPerMaster - The number of read replicas per DB instance. The used 81// value is the highest number of read replicas for a DB instance in the account. 82// Other DB instances in the account might have a lower number of read replicas. 83// 84// * 85// ReservedDBInstances - The number of reserved DB instances per account. The used 86// value is the count of the active reserved DB instances in the account. 87// 88// * 89// SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used 90// value is highest number of subnets for a DB subnet group in the account. Other 91// DB subnet groups in the account might have a lower number of subnets. 92// 93// For more 94// information, see Quotas for Amazon RDS 95// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) in the 96// Amazon RDS User Guide and Quotas for Amazon Aurora 97// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html) 98// in the Amazon Aurora User Guide. 99type AccountQuota struct { 100 101 // The name of the Amazon RDS quota for this AWS account. 102 AccountQuotaName *string 103 104 // The maximum allowed value for the quota. 105 Max int64 106 107 // The amount currently used toward the quota maximum. 108 Used int64 109} 110 111// Contains Availability Zone information. This data type is used as an element in 112// the OrderableDBInstanceOption data type. 113type AvailabilityZone struct { 114 115 // The name of the Availability Zone. 116 Name *string 117} 118 119// Contains the available processor feature information for the DB instance class 120// of a DB instance. For more information, see Configuring the Processor of the DB 121// Instance Class 122// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) 123// in the Amazon RDS User Guide. 124type AvailableProcessorFeature struct { 125 126 // The allowed values for the processor feature of the DB instance class. 127 AllowedValues *string 128 129 // The default value for the processor feature of the DB instance class. 130 DefaultValue *string 131 132 // The name of the processor feature. Valid names are coreCount and threadsPerCore. 133 Name *string 134} 135 136// A CA certificate for an AWS account. 137type Certificate struct { 138 139 // The Amazon Resource Name (ARN) for the certificate. 140 CertificateArn *string 141 142 // The unique key that identifies a certificate. 143 CertificateIdentifier *string 144 145 // The type of the certificate. 146 CertificateType *string 147 148 // Whether there is an override for the default certificate identifier. 149 CustomerOverride *bool 150 151 // If there is an override for the default certificate identifier, when the 152 // override expires. 153 CustomerOverrideValidTill *time.Time 154 155 // The thumbprint of the certificate. 156 Thumbprint *string 157 158 // The starting date from which the certificate is valid. 159 ValidFrom *time.Time 160 161 // The final date that the certificate continues to be valid. 162 ValidTill *time.Time 163} 164 165// This data type is used as a response element in the action 166// DescribeDBEngineVersions. 167type CharacterSet struct { 168 169 // The description of the character set. 170 CharacterSetDescription *string 171 172 // The name of the character set. 173 CharacterSetName *string 174} 175 176// The configuration setting for the log types to be enabled for export to 177// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and 178// DisableLogTypes arrays determine which logs will be exported (or not exported) 179// to CloudWatch Logs. The values within these arrays depend on the DB engine being 180// used. For more information about exporting CloudWatch Logs for Amazon RDS DB 181// instances, see Publishing Database Logs to Amazon CloudWatch Logs 182// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) 183// in the Amazon RDS User Guide. For more information about exporting CloudWatch 184// Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon 185// CloudWatch Logs 186// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) 187// in the Amazon Aurora User Guide. 188type CloudwatchLogsExportConfiguration struct { 189 190 // The list of log types to disable. 191 DisableLogTypes []string 192 193 // The list of log types to enable. 194 EnableLogTypes []string 195} 196 197// This data type is used as a response element in the ModifyDBCluster operation 198// and contains changes that will be applied during the next maintenance window. 199type ClusterPendingModifiedValues struct { 200 201 // The DBClusterIdentifier for the DB cluster. 202 DBClusterIdentifier *string 203 204 // The database engine version. 205 EngineVersion *string 206 207 // Whether mapping of AWS Identity and Access Management (IAM) accounts to database 208 // accounts is enabled. 209 IAMDatabaseAuthenticationEnabled *bool 210 211 // The master credentials for the DB cluster. 212 MasterUserPassword *string 213 214 // A list of the log types whose configuration is still pending. In other words, 215 // these log types are in the process of being activated or deactivated. 216 PendingCloudwatchLogsExports *PendingCloudwatchLogsExports 217} 218 219// Specifies the settings that control the size and behavior of the connection pool 220// associated with a DBProxyTargetGroup. 221type ConnectionPoolConfiguration struct { 222 223 // The number of seconds for a proxy to wait for a connection to become available 224 // in the connection pool. Only applies when the proxy has opened its maximum 225 // number of connections and all connections are busy with client sessions. 226 // Default: 120 Constraints: between 1 and 3600, or 0 representing unlimited 227 ConnectionBorrowTimeout *int32 228 229 // One or more SQL statements for the proxy to run when opening each new database 230 // connection. Typically used with SET statements to make sure that each connection 231 // has identical settings such as time zone and character set. For multiple 232 // statements, use semicolons as the separator. You can also include multiple 233 // variables in a single SET statement, such as SET x=1, y=2. Default: no 234 // initialization query 235 InitQuery *string 236 237 // The maximum size of the connection pool for each target in a target group. For 238 // Aurora MySQL, it is expressed as a percentage of the max_connections setting for 239 // the RDS DB instance or Aurora DB cluster used by the target group. Default: 100 240 // Constraints: between 1 and 100 241 MaxConnectionsPercent *int32 242 243 // Controls how actively the proxy closes idle database connections in the 244 // connection pool. A high value enables the proxy to leave a high percentage of 245 // idle connections open. A low value causes the proxy to close idle client 246 // connections and return the underlying database connections to the connection 247 // pool. For Aurora MySQL, it is expressed as a percentage of the max_connections 248 // setting for the RDS DB instance or Aurora DB cluster used by the target group. 249 // Default: 50 Constraints: between 0 and MaxConnectionsPercent 250 MaxIdleConnectionsPercent *int32 251 252 // Each item in the list represents a class of SQL operations that normally cause 253 // all later statements in a session using a proxy to be pinned to the same 254 // underlying database connection. Including an item in the list exempts that class 255 // of SQL operations from the pinning behavior. Default: no session pinning filters 256 SessionPinningFilters []string 257} 258 259// Displays the settings that control the size and behavior of the connection pool 260// associated with a DBProxyTarget. 261type ConnectionPoolConfigurationInfo struct { 262 263 // The number of seconds for a proxy to wait for a connection to become available 264 // in the connection pool. Only applies when the proxy has opened its maximum 265 // number of connections and all connections are busy with client sessions. 266 ConnectionBorrowTimeout int32 267 268 // One or more SQL statements for the proxy to run when opening each new database 269 // connection. Typically used with SET statements to make sure that each connection 270 // has identical settings such as time zone and character set. This setting is 271 // empty by default. For multiple statements, use semicolons as the separator. You 272 // can also include multiple variables in a single SET statement, such as SET x=1, 273 // y=2. 274 InitQuery *string 275 276 // The maximum size of the connection pool for each target in a target group. For 277 // Aurora MySQL, it is expressed as a percentage of the max_connections setting for 278 // the RDS DB instance or Aurora DB cluster used by the target group. 279 MaxConnectionsPercent int32 280 281 // Controls how actively the proxy closes idle database connections in the 282 // connection pool. A high value enables the proxy to leave a high percentage of 283 // idle connections open. A low value causes the proxy to close idle client 284 // connections and return the underlying database connections to the connection 285 // pool. For Aurora MySQL, it is expressed as a percentage of the max_connections 286 // setting for the RDS DB instance or Aurora DB cluster used by the target group. 287 MaxIdleConnectionsPercent int32 288 289 // Each item in the list represents a class of SQL operations that normally cause 290 // all later statements in a session using a proxy to be pinned to the same 291 // underlying database connection. Including an item in the list exempts that class 292 // of SQL operations from the pinning behavior. Currently, the only allowed value 293 // is EXCLUDE_VARIABLE_SETS. 294 SessionPinningFilters []string 295} 296 297// A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a 298// VMware vSphere cluster. For more information about RDS on VMware, see the RDS 299// on VMware User Guide. 300// (https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html) 301type CustomAvailabilityZone struct { 302 303 // The identifier of the custom AZ. Amazon RDS generates a unique identifier when a 304 // custom AZ is created. 305 CustomAvailabilityZoneId *string 306 307 // The name of the custom AZ. 308 CustomAvailabilityZoneName *string 309 310 // The status of the custom AZ. 311 CustomAvailabilityZoneStatus *string 312 313 // Information about the virtual private network (VPN) between the VMware vSphere 314 // cluster and the AWS website. 315 VpnDetails *VpnDetails 316} 317 318// Contains the details of an Amazon Aurora DB cluster. This data type is used as a 319// response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster 320// actions. 321type DBCluster struct { 322 323 // The name of the Amazon Kinesis data stream used for the database activity 324 // stream. 325 ActivityStreamKinesisStreamName *string 326 327 // The AWS KMS key identifier used for encrypting messages in the database activity 328 // stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias 329 // name for the AWS KMS customer master key (CMK). 330 ActivityStreamKmsKeyId *string 331 332 // The mode of the database activity stream. Database events such as a change or 333 // access generate an activity stream event. The database session can handle these 334 // events either synchronously or asynchronously. 335 ActivityStreamMode ActivityStreamMode 336 337 // The status of the database activity stream. 338 ActivityStreamStatus ActivityStreamStatus 339 340 // For all database engines except Amazon Aurora, AllocatedStorage specifies the 341 // allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 342 // returns 1, because Aurora DB cluster storage size isn't fixed, but instead 343 // automatically adjusts as needed. 344 AllocatedStorage *int32 345 346 // Provides a list of the AWS Identity and Access Management (IAM) roles that are 347 // associated with the DB cluster. IAM roles that are associated with a DB cluster 348 // grant permission for the DB cluster to access other AWS services on your behalf. 349 AssociatedRoles []DBClusterRole 350 351 // Provides the list of Availability Zones (AZs) where instances in the DB cluster 352 // can be created. 353 AvailabilityZones []string 354 355 // The number of change records stored for Backtrack. 356 BacktrackConsumedChangeRecords *int64 357 358 // The target backtrack window, in seconds. If this value is set to 0, backtracking 359 // is disabled for the DB cluster. Otherwise, backtracking is enabled. 360 BacktrackWindow *int64 361 362 // Specifies the number of days for which automatic DB snapshots are retained. 363 BackupRetentionPeriod *int32 364 365 // The current capacity of an Aurora Serverless DB cluster. The capacity is 0 366 // (zero) when the cluster is paused. For more information about Aurora Serverless, 367 // see Using Amazon Aurora Serverless 368 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) 369 // in the Amazon Aurora User Guide. 370 Capacity *int32 371 372 // If present, specifies the name of the character set that this cluster is 373 // associated with. 374 CharacterSetName *string 375 376 // Identifies the clone group to which the DB cluster is associated. 377 CloneGroupId *string 378 379 // Specifies the time when the DB cluster was created, in Universal Coordinated 380 // Time (UTC). 381 ClusterCreateTime *time.Time 382 383 // Specifies whether tags are copied from the DB cluster to snapshots of the DB 384 // cluster. 385 CopyTagsToSnapshot *bool 386 387 // Specifies whether the DB cluster is a clone of a DB cluster owned by a different 388 // AWS account. 389 CrossAccountClone *bool 390 391 // Identifies all custom endpoints associated with the cluster. 392 CustomEndpoints []string 393 394 // The Amazon Resource Name (ARN) for the DB cluster. 395 DBClusterArn *string 396 397 // Contains a user-supplied DB cluster identifier. This identifier is the unique 398 // key that identifies a DB cluster. 399 DBClusterIdentifier *string 400 401 // Provides the list of instances that make up the DB cluster. 402 DBClusterMembers []DBClusterMember 403 404 // Provides the list of option group memberships for this DB cluster. 405 DBClusterOptionGroupMemberships []DBClusterOptionGroupStatus 406 407 // Specifies the name of the DB cluster parameter group for the DB cluster. 408 DBClusterParameterGroup *string 409 410 // Specifies information on the subnet group associated with the DB cluster, 411 // including the name, description, and subnets in the subnet group. 412 DBSubnetGroup *string 413 414 // Contains the name of the initial database of this DB cluster that was provided 415 // at create time, if one was specified when the DB cluster was created. This same 416 // name is returned for the life of the DB cluster. 417 DatabaseName *string 418 419 // The AWS Region-unique, immutable identifier for the DB cluster. This identifier 420 // is found in AWS CloudTrail log entries whenever the AWS KMS CMK for the DB 421 // cluster is accessed. 422 DbClusterResourceId *string 423 424 // Indicates if the DB cluster has deletion protection enabled. The database can't 425 // be deleted when deletion protection is enabled. 426 DeletionProtection *bool 427 428 // The Active Directory Domain membership records associated with the DB cluster. 429 DomainMemberships []DomainMembership 430 431 // The earliest time to which a DB cluster can be backtracked. 432 EarliestBacktrackTime *time.Time 433 434 // The earliest time to which a database can be restored with point-in-time 435 // restore. 436 EarliestRestorableTime *time.Time 437 438 // A list of log types that this DB cluster is configured to export to CloudWatch 439 // Logs. Log types vary by DB engine. For information about the log types for each 440 // DB engine, see Amazon RDS Database Log Files 441 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html) 442 // in the Amazon Aurora User Guide. 443 EnabledCloudwatchLogsExports []string 444 445 // Specifies the connection endpoint for the primary instance of the DB cluster. 446 Endpoint *string 447 448 // The name of the database engine to be used for this DB cluster. 449 Engine *string 450 451 // The DB engine mode of the DB cluster, either provisioned, serverless, 452 // parallelquery, global, or multimaster. For more information, see 453 // CreateDBCluster 454 // (https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html). 455 EngineMode *string 456 457 // Indicates the database engine version. 458 EngineVersion *string 459 460 // Specifies whether you have requested to enable write forwarding for a secondary 461 // cluster in an Aurora global database. Because write forwarding takes time to 462 // enable, check the value of GlobalWriteForwardingStatus to confirm that the 463 // request has completed before using the write forwarding feature for this 464 // cluster. 465 GlobalWriteForwardingRequested *bool 466 467 // Specifies whether a secondary cluster in an Aurora global database has write 468 // forwarding enabled, not enabled, or is in the process of enabling it. 469 GlobalWriteForwardingStatus WriteForwardingStatus 470 471 // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. 472 HostedZoneId *string 473 474 // A value that indicates whether the HTTP endpoint for an Aurora Serverless DB 475 // cluster is enabled. When enabled, the HTTP endpoint provides a connectionless 476 // web service API for running SQL queries on the Aurora Serverless DB cluster. You 477 // can also query your database from inside the RDS console with the query editor. 478 // For more information, see Using the Data API for Aurora Serverless 479 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in 480 // the Amazon Aurora User Guide. 481 HttpEndpointEnabled *bool 482 483 // A value that indicates whether the mapping of AWS Identity and Access Management 484 // (IAM) accounts to database accounts is enabled. 485 IAMDatabaseAuthenticationEnabled *bool 486 487 // If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB 488 // cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias 489 // name for the AWS KMS customer master key (CMK). 490 KmsKeyId *string 491 492 // Specifies the latest time to which a database can be restored with point-in-time 493 // restore. 494 LatestRestorableTime *time.Time 495 496 // Contains the master username for the DB cluster. 497 MasterUsername *string 498 499 // Specifies whether the DB cluster has instances in multiple Availability Zones. 500 MultiAZ *bool 501 502 // Specifies that changes to the DB cluster are pending. This element is only 503 // included when changes are pending. Specific changes are identified by 504 // subelements. 505 PendingModifiedValues *ClusterPendingModifiedValues 506 507 // Specifies the progress of the operation as a percentage. 508 PercentProgress *string 509 510 // Specifies the port that the database engine is listening on. 511 Port *int32 512 513 // Specifies the daily time range during which automated backups are created if 514 // automated backups are enabled, as determined by the BackupRetentionPeriod. 515 PreferredBackupWindow *string 516 517 // Specifies the weekly time range during which system maintenance can occur, in 518 // Universal Coordinated Time (UTC). 519 PreferredMaintenanceWindow *string 520 521 // Contains one or more identifiers of the read replicas associated with this DB 522 // cluster. 523 ReadReplicaIdentifiers []string 524 525 // The reader endpoint for the DB cluster. The reader endpoint for a DB cluster 526 // load-balances connections across the Aurora Replicas that are available in a DB 527 // cluster. As clients request new connections to the reader endpoint, Aurora 528 // distributes the connection requests among the Aurora Replicas in the DB cluster. 529 // This functionality can help balance your read workload across multiple Aurora 530 // Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that 531 // you are connected to is promoted to be the primary instance, your connection is 532 // dropped. To continue sending your read workload to other Aurora Replicas in the 533 // cluster, you can then reconnect to the reader endpoint. 534 ReaderEndpoint *string 535 536 // Contains the identifier of the source DB cluster if this DB cluster is a read 537 // replica. 538 ReplicationSourceIdentifier *string 539 540 // Shows the scaling configuration for an Aurora DB cluster in serverless DB engine 541 // mode. For more information, see Using Amazon Aurora Serverless 542 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) 543 // in the Amazon Aurora User Guide. 544 ScalingConfigurationInfo *ScalingConfigurationInfo 545 546 // Specifies the current state of this DB cluster. 547 Status *string 548 549 // Specifies whether the DB cluster is encrypted. 550 StorageEncrypted bool 551 552 // A list of tags. For more information, see Tagging Amazon RDS Resources 553 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in 554 // the Amazon RDS User Guide. 555 TagList []Tag 556 557 // Provides a list of VPC security groups that the DB cluster belongs to. 558 VpcSecurityGroups []VpcSecurityGroupMembership 559} 560 561// This data type is used as a response element in the DescribeDBClusterBacktracks 562// action. 563type DBClusterBacktrack struct { 564 565 // Contains the backtrack identifier. 566 BacktrackIdentifier *string 567 568 // The timestamp of the time at which the backtrack was requested. 569 BacktrackRequestCreationTime *time.Time 570 571 // The timestamp of the time to which the DB cluster was backtracked. 572 BacktrackTo *time.Time 573 574 // The timestamp of the time from which the DB cluster was backtracked. 575 BacktrackedFrom *time.Time 576 577 // Contains a user-supplied DB cluster identifier. This identifier is the unique 578 // key that identifies a DB cluster. 579 DBClusterIdentifier *string 580 581 // The status of the backtrack. This property returns one of the following 582 // values: 583 // 584 // * applying - The backtrack is currently being applied to or rolled back 585 // from the DB cluster. 586 // 587 // * completed - The backtrack has successfully been applied 588 // to or rolled back from the DB cluster. 589 // 590 // * failed - An error occurred while the 591 // backtrack was applied to or rolled back from the DB cluster. 592 // 593 // * pending - The 594 // backtrack is currently pending application to or rollback from the DB cluster. 595 Status *string 596} 597 598// This data type represents the information you need to connect to an Amazon 599// Aurora DB cluster. This data type is used as a response element in the following 600// actions: 601// 602// * CreateDBClusterEndpoint 603// 604// * DescribeDBClusterEndpoints 605// 606// * 607// ModifyDBClusterEndpoint 608// 609// * DeleteDBClusterEndpoint 610// 611// For the data structure that 612// represents Amazon RDS DB instance endpoints, see Endpoint. 613type DBClusterEndpoint struct { 614 615 // The type associated with a custom endpoint. One of: READER, WRITER, ANY. 616 CustomEndpointType *string 617 618 // The Amazon Resource Name (ARN) for the endpoint. 619 DBClusterEndpointArn *string 620 621 // The identifier associated with the endpoint. This parameter is stored as a 622 // lowercase string. 623 DBClusterEndpointIdentifier *string 624 625 // A unique system-generated identifier for an endpoint. It remains the same for 626 // the whole life of the endpoint. 627 DBClusterEndpointResourceIdentifier *string 628 629 // The DB cluster identifier of the DB cluster associated with the endpoint. This 630 // parameter is stored as a lowercase string. 631 DBClusterIdentifier *string 632 633 // The DNS address of the endpoint. 634 Endpoint *string 635 636 // The type of the endpoint. One of: READER, WRITER, CUSTOM. 637 EndpointType *string 638 639 // List of DB instance identifiers that aren't part of the custom endpoint group. 640 // All other eligible instances are reachable through the custom endpoint. Only 641 // relevant if the list of static members is empty. 642 ExcludedMembers []string 643 644 // List of DB instance identifiers that are part of the custom endpoint group. 645 StaticMembers []string 646 647 // The current status of the endpoint. One of: creating, available, deleting, 648 // inactive, modifying. The inactive state applies to an endpoint that can't be 649 // used for a certain kind of cluster, such as a writer endpoint for a read-only 650 // secondary cluster in a global database. 651 Status *string 652} 653 654// Contains information about an instance that is part of a DB cluster. 655type DBClusterMember struct { 656 657 // Specifies the status of the DB cluster parameter group for this member of the DB 658 // cluster. 659 DBClusterParameterGroupStatus *string 660 661 // Specifies the instance identifier for this member of the DB cluster. 662 DBInstanceIdentifier *string 663 664 // Value that is true if the cluster member is the primary instance for the DB 665 // cluster and false otherwise. 666 IsClusterWriter bool 667 668 // A value that specifies the order in which an Aurora Replica is promoted to the 669 // primary instance after a failure of the existing primary instance. For more 670 // information, see Fault Tolerance for an Aurora DB Cluster 671 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) 672 // in the Amazon Aurora User Guide. 673 PromotionTier *int32 674} 675 676// Contains status information for a DB cluster option group. 677type DBClusterOptionGroupStatus struct { 678 679 // Specifies the name of the DB cluster option group. 680 DBClusterOptionGroupName *string 681 682 // Specifies the status of the DB cluster option group. 683 Status *string 684} 685 686// Contains the details of an Amazon RDS DB cluster parameter group. This data type 687// is used as a response element in the DescribeDBClusterParameterGroups action. 688type DBClusterParameterGroup struct { 689 690 // The Amazon Resource Name (ARN) for the DB cluster parameter group. 691 DBClusterParameterGroupArn *string 692 693 // The name of the DB cluster parameter group. 694 DBClusterParameterGroupName *string 695 696 // The name of the DB parameter group family that this DB cluster parameter group 697 // is compatible with. 698 DBParameterGroupFamily *string 699 700 // Provides the customer-specified description for this DB cluster parameter group. 701 Description *string 702} 703 704// Describes an AWS Identity and Access Management (IAM) role that is associated 705// with a DB cluster. 706type DBClusterRole struct { 707 708 // The name of the feature associated with the AWS Identity and Access Management 709 // (IAM) role. For the list of supported feature names, see DBEngineVersion. 710 FeatureName *string 711 712 // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB 713 // cluster. 714 RoleArn *string 715 716 // Describes the state of association between the IAM role and the DB cluster. The 717 // Status property returns one of the following values: 718 // 719 // * ACTIVE - the IAM role 720 // ARN is associated with the DB cluster and can be used to access other AWS 721 // services on your behalf. 722 // 723 // * PENDING - the IAM role ARN is being associated with 724 // the DB cluster. 725 // 726 // * INVALID - the IAM role ARN is associated with the DB cluster, 727 // but the DB cluster is unable to assume the IAM role in order to access other AWS 728 // services on your behalf. 729 Status *string 730} 731 732// Contains the details for an Amazon RDS DB cluster snapshot This data type is 733// used as a response element in the DescribeDBClusterSnapshots action. 734type DBClusterSnapshot struct { 735 736 // Specifies the allocated storage size in gibibytes (GiB). 737 AllocatedStorage int32 738 739 // Provides the list of Availability Zones (AZs) where instances in the DB cluster 740 // snapshot can be restored. 741 AvailabilityZones []string 742 743 // Specifies the time when the DB cluster was created, in Universal Coordinated 744 // Time (UTC). 745 ClusterCreateTime *time.Time 746 747 // Specifies the DB cluster identifier of the DB cluster that this DB cluster 748 // snapshot was created from. 749 DBClusterIdentifier *string 750 751 // The Amazon Resource Name (ARN) for the DB cluster snapshot. 752 DBClusterSnapshotArn *string 753 754 // Specifies the identifier for the DB cluster snapshot. 755 DBClusterSnapshotIdentifier *string 756 757 // Specifies the name of the database engine. 758 Engine *string 759 760 // Provides the version of the database engine for this DB cluster snapshot. 761 EngineVersion *string 762 763 // True if mapping of AWS Identity and Access Management (IAM) accounts to database 764 // accounts is enabled, and otherwise false. 765 IAMDatabaseAuthenticationEnabled bool 766 767 // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB 768 // cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, 769 // or alias name for the AWS KMS customer master key (CMK). 770 KmsKeyId *string 771 772 // Provides the license model information for this DB cluster snapshot. 773 LicenseModel *string 774 775 // Provides the master username for the DB cluster snapshot. 776 MasterUsername *string 777 778 // Specifies the percentage of the estimated data that has been transferred. 779 PercentProgress int32 780 781 // Specifies the port that the DB cluster was listening on at the time of the 782 // snapshot. 783 Port int32 784 785 // Provides the time when the snapshot was taken, in Universal Coordinated Time 786 // (UTC). 787 SnapshotCreateTime *time.Time 788 789 // Provides the type of the DB cluster snapshot. 790 SnapshotType *string 791 792 // If the DB cluster snapshot was copied from a source DB cluster snapshot, the 793 // Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null 794 // value. 795 SourceDBClusterSnapshotArn *string 796 797 // Specifies the status of this DB cluster snapshot. 798 Status *string 799 800 // Specifies whether the DB cluster snapshot is encrypted. 801 StorageEncrypted bool 802 803 // A list of tags. For more information, see Tagging Amazon RDS Resources 804 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in 805 // the Amazon RDS User Guide. 806 TagList []Tag 807 808 // Provides the VPC ID associated with the DB cluster snapshot. 809 VpcId *string 810} 811 812// Contains the name and values of a manual DB cluster snapshot attribute. Manual 813// DB cluster snapshot attributes are used to authorize other AWS accounts to 814// restore a manual DB cluster snapshot. For more information, see the 815// ModifyDBClusterSnapshotAttribute API action. 816type DBClusterSnapshotAttribute struct { 817 818 // The name of the manual DB cluster snapshot attribute. The attribute named 819 // restore refers to the list of AWS accounts that have permission to copy or 820 // restore the manual DB cluster snapshot. For more information, see the 821 // ModifyDBClusterSnapshotAttribute API action. 822 AttributeName *string 823 824 // The value(s) for the manual DB cluster snapshot attribute. If the AttributeName 825 // field is set to restore, then this element returns a list of IDs of the AWS 826 // accounts that are authorized to copy or restore the manual DB cluster snapshot. 827 // If a value of all is in the list, then the manual DB cluster snapshot is public 828 // and available for any AWS account to copy or restore. 829 AttributeValues []string 830} 831 832// Contains the results of a successful call to the 833// DescribeDBClusterSnapshotAttributes API action. Manual DB cluster snapshot 834// attributes are used to authorize other AWS accounts to copy or restore a manual 835// DB cluster snapshot. For more information, see the 836// ModifyDBClusterSnapshotAttribute API action. 837type DBClusterSnapshotAttributesResult struct { 838 839 // The list of attributes and values for the manual DB cluster snapshot. 840 DBClusterSnapshotAttributes []DBClusterSnapshotAttribute 841 842 // The identifier of the manual DB cluster snapshot that the attributes apply to. 843 DBClusterSnapshotIdentifier *string 844} 845 846// This data type is used as a response element in the action 847// DescribeDBEngineVersions. 848type DBEngineVersion struct { 849 850 // The description of the database engine. 851 DBEngineDescription *string 852 853 // The description of the database engine version. 854 DBEngineVersionDescription *string 855 856 // The name of the DB parameter group family for the database engine. 857 DBParameterGroupFamily *string 858 859 // The default character set for new instances of this engine version, if the 860 // CharacterSetName parameter of the CreateDBInstance API isn't specified. 861 DefaultCharacterSet *CharacterSet 862 863 // The name of the database engine. 864 Engine *string 865 866 // The version number of the database engine. 867 EngineVersion *string 868 869 // The types of logs that the database engine has available for export to 870 // CloudWatch Logs. 871 ExportableLogTypes []string 872 873 // The status of the DB engine version, either available or deprecated. 874 Status *string 875 876 // A list of the character sets supported by this engine for the CharacterSetName 877 // parameter of the CreateDBInstance operation. 878 SupportedCharacterSets []CharacterSet 879 880 // A list of the supported DB engine modes. 881 SupportedEngineModes []string 882 883 // A list of features supported by the DB engine. Supported feature names include 884 // the following. 885 // 886 // * s3Import 887 SupportedFeatureNames []string 888 889 // A list of the character sets supported by the Oracle DB engine for the 890 // NcharCharacterSetName parameter of the CreateDBInstance operation. 891 SupportedNcharCharacterSets []CharacterSet 892 893 // A list of the time zones supported by this engine for the Timezone parameter of 894 // the CreateDBInstance action. 895 SupportedTimezones []Timezone 896 897 // A value that indicates whether you can use Aurora global databases with a 898 // specific DB engine version. 899 SupportsGlobalDatabases bool 900 901 // A value that indicates whether the engine version supports exporting the log 902 // types specified by ExportableLogTypes to CloudWatch Logs. 903 SupportsLogExportsToCloudwatchLogs bool 904 905 // A value that indicates whether you can use Aurora parallel query with a specific 906 // DB engine version. 907 SupportsParallelQuery bool 908 909 // Indicates whether the database engine version supports read replicas. 910 SupportsReadReplica bool 911 912 // A list of engine versions that this database engine version can be upgraded to. 913 ValidUpgradeTarget []UpgradeTarget 914} 915 916// Contains the details of an Amazon RDS DB instance. This data type is used as a 917// response element in the DescribeDBInstances action. 918type DBInstance struct { 919 920 // Specifies the allocated storage size specified in gibibytes. 921 AllocatedStorage int32 922 923 // The AWS Identity and Access Management (IAM) roles associated with the DB 924 // instance. 925 AssociatedRoles []DBInstanceRole 926 927 // Indicates that minor version patches are applied automatically. 928 AutoMinorVersionUpgrade bool 929 930 // Specifies the name of the Availability Zone the DB instance is located in. 931 AvailabilityZone *string 932 933 // Specifies the number of days for which automatic DB snapshots are retained. 934 BackupRetentionPeriod int32 935 936 // The identifier of the CA certificate for this DB instance. 937 CACertificateIdentifier *string 938 939 // If present, specifies the name of the character set that this instance is 940 // associated with. 941 CharacterSetName *string 942 943 // Specifies whether tags are copied from the DB instance to snapshots of the DB 944 // instance. Amazon Aurora Not applicable. Copying tags to snapshots is managed by 945 // the DB cluster. Setting this value for an Aurora DB instance has no effect on 946 // the DB cluster setting. For more information, see DBCluster. 947 CopyTagsToSnapshot bool 948 949 // Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on 950 // Outposts DB instance. A CoIP provides local or external connectivity to 951 // resources in your Outpost subnets through your on-premises network. For some use 952 // cases, a CoIP can provide lower latency for connections to the DB instance from 953 // outside of its virtual private cloud (VPC) on your local network. For more 954 // information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts 955 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in 956 // the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned 957 // IP addresses 958 // (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing) 959 // in the AWS Outposts User Guide. 960 CustomerOwnedIpEnabled *bool 961 962 // If the DB instance is a member of a DB cluster, contains the name of the DB 963 // cluster that the DB instance is a member of. 964 DBClusterIdentifier *string 965 966 // The Amazon Resource Name (ARN) for the DB instance. 967 DBInstanceArn *string 968 969 // The list of replicated automated backups associated with the DB instance. 970 DBInstanceAutomatedBackupsReplications []DBInstanceAutomatedBackupsReplication 971 972 // Contains the name of the compute and memory capacity class of the DB instance. 973 DBInstanceClass *string 974 975 // Contains a user-supplied database identifier. This identifier is the unique key 976 // that identifies a DB instance. 977 DBInstanceIdentifier *string 978 979 // Specifies the current state of this database. For information about DB instance 980 // statuses, see DB Instance Status 981 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Status.html) 982 // in the Amazon RDS User Guide. 983 DBInstanceStatus *string 984 985 // The meaning of this parameter differs according to the database engine you use. 986 // MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database 987 // of this instance that was provided at create time, if one was specified when the 988 // DB instance was created. This same name is returned for the life of the DB 989 // instance. Type: String Oracle Contains the Oracle System ID (SID) of the created 990 // DB instance. Not shown when the returned parameters do not apply to an Oracle DB 991 // instance. 992 DBName *string 993 994 // Provides the list of DB parameter groups applied to this DB instance. 995 DBParameterGroups []DBParameterGroupStatus 996 997 // A list of DB security group elements containing DBSecurityGroup.Name and 998 // DBSecurityGroup.Status subelements. 999 DBSecurityGroups []DBSecurityGroupMembership 1000 1001 // Specifies information on the subnet group associated with the DB instance, 1002 // including the name, description, and subnets in the subnet group. 1003 DBSubnetGroup *DBSubnetGroup 1004 1005 // Specifies the port that the DB instance listens on. If the DB instance is part 1006 // of a DB cluster, this can be a different port than the DB cluster port. 1007 DbInstancePort int32 1008 1009 // The AWS Region-unique, immutable identifier for the DB instance. This identifier 1010 // is found in AWS CloudTrail log entries whenever the AWS KMS customer master key 1011 // (CMK) for the DB instance is accessed. 1012 DbiResourceId *string 1013 1014 // Indicates if the DB instance has deletion protection enabled. The database can't 1015 // be deleted when deletion protection is enabled. For more information, see 1016 // Deleting a DB Instance 1017 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). 1018 DeletionProtection bool 1019 1020 // The Active Directory Domain membership records associated with the DB instance. 1021 DomainMemberships []DomainMembership 1022 1023 // A list of log types that this DB instance is configured to export to CloudWatch 1024 // Logs. Log types vary by DB engine. For information about the log types for each 1025 // DB engine, see Amazon RDS Database Log Files 1026 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html) in 1027 // the Amazon RDS User Guide. 1028 EnabledCloudwatchLogsExports []string 1029 1030 // Specifies the connection endpoint. 1031 Endpoint *Endpoint 1032 1033 // The name of the database engine to be used for this DB instance. 1034 Engine *string 1035 1036 // Indicates the database engine version. 1037 EngineVersion *string 1038 1039 // The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that 1040 // receives the Enhanced Monitoring metrics data for the DB instance. 1041 EnhancedMonitoringResourceArn *string 1042 1043 // True if mapping of AWS Identity and Access Management (IAM) accounts to database 1044 // accounts is enabled, and otherwise false. IAM database authentication can be 1045 // enabled for the following database engines 1046 // 1047 // * For MySQL 5.6, minor version 1048 // 5.6.34 or higher 1049 // 1050 // * For MySQL 5.7, minor version 5.7.16 or higher 1051 // 1052 // * Aurora 5.6 1053 // or higher. To enable IAM database authentication for Aurora, see DBCluster Type. 1054 IAMDatabaseAuthenticationEnabled bool 1055 1056 // Provides the date and time the DB instance was created. 1057 InstanceCreateTime *time.Time 1058 1059 // Specifies the Provisioned IOPS (I/O operations per second) value. 1060 Iops *int32 1061 1062 // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB 1063 // instance. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias 1064 // name for the AWS KMS customer master key (CMK). 1065 KmsKeyId *string 1066 1067 // Specifies the latest time to which a database can be restored with point-in-time 1068 // restore. 1069 LatestRestorableTime *time.Time 1070 1071 // License model information for this DB instance. 1072 LicenseModel *string 1073 1074 // Specifies the listener connection endpoint for SQL Server Always On. 1075 ListenerEndpoint *Endpoint 1076 1077 // Contains the master username for the DB instance. 1078 MasterUsername *string 1079 1080 // The upper limit to which Amazon RDS can automatically scale the storage of the 1081 // DB instance. 1082 MaxAllocatedStorage *int32 1083 1084 // The interval, in seconds, between points when Enhanced Monitoring metrics are 1085 // collected for the DB instance. 1086 MonitoringInterval *int32 1087 1088 // The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to 1089 // Amazon CloudWatch Logs. 1090 MonitoringRoleArn *string 1091 1092 // Specifies if the DB instance is a Multi-AZ deployment. 1093 MultiAZ bool 1094 1095 // The name of the NCHAR character set for the Oracle DB instance. This character 1096 // set specifies the Unicode encoding for data stored in table columns of type 1097 // NCHAR, NCLOB, or NVARCHAR2. 1098 NcharCharacterSetName *string 1099 1100 // Provides the list of option group memberships for this DB instance. 1101 OptionGroupMemberships []OptionGroupMembership 1102 1103 // Specifies that changes to the DB instance are pending. This element is only 1104 // included when changes are pending. Specific changes are identified by 1105 // subelements. 1106 PendingModifiedValues *PendingModifiedValues 1107 1108 // True if Performance Insights is enabled for the DB instance, and otherwise 1109 // false. 1110 PerformanceInsightsEnabled *bool 1111 1112 // The AWS KMS key identifier for encryption of Performance Insights data. The AWS 1113 // KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS 1114 // KMS customer master key (CMK). 1115 PerformanceInsightsKMSKeyId *string 1116 1117 // The amount of time, in days, to retain Performance Insights data. Valid values 1118 // are 7 or 731 (2 years). 1119 PerformanceInsightsRetentionPeriod *int32 1120 1121 // Specifies the daily time range during which automated backups are created if 1122 // automated backups are enabled, as determined by the BackupRetentionPeriod. 1123 PreferredBackupWindow *string 1124 1125 // Specifies the weekly time range during which system maintenance can occur, in 1126 // Universal Coordinated Time (UTC). 1127 PreferredMaintenanceWindow *string 1128 1129 // The number of CPU cores and the number of threads per core for the DB instance 1130 // class of the DB instance. 1131 ProcessorFeatures []ProcessorFeature 1132 1133 // A value that specifies the order in which an Aurora Replica is promoted to the 1134 // primary instance after a failure of the existing primary instance. For more 1135 // information, see Fault Tolerance for an Aurora DB Cluster 1136 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) 1137 // in the Amazon Aurora User Guide. 1138 PromotionTier *int32 1139 1140 // Specifies the accessibility options for the DB instance. When the DB instance is 1141 // publicly accessible, its DNS endpoint resolves to the private IP address from 1142 // within the DB instance's VPC, and to the public IP address from outside of the 1143 // DB instance's VPC. Access to the DB instance is ultimately controlled by the 1144 // security group it uses, and that public access is not permitted if the security 1145 // group assigned to the DB instance doesn't permit it. When the DB instance isn't 1146 // publicly accessible, it is an internal DB instance with a DNS name that resolves 1147 // to a private IP address. For more information, see CreateDBInstance. 1148 PubliclyAccessible bool 1149 1150 // Contains one or more identifiers of Aurora DB clusters to which the RDS DB 1151 // instance is replicated as a read replica. For example, when you create an Aurora 1152 // read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the 1153 // Aurora read replica is shown. This output does not contain information about 1154 // cross region Aurora read replicas. Currently, each RDS DB instance can have only 1155 // one Aurora read replica. 1156 ReadReplicaDBClusterIdentifiers []string 1157 1158 // Contains one or more identifiers of the read replicas associated with this DB 1159 // instance. 1160 ReadReplicaDBInstanceIdentifiers []string 1161 1162 // Contains the identifier of the source DB instance if this DB instance is a read 1163 // replica. 1164 ReadReplicaSourceDBInstanceIdentifier *string 1165 1166 // The open mode of an Oracle read replica. The default is open-read-only. For more 1167 // information, see Working with Oracle Read Replicas for Amazon RDS 1168 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) 1169 // in the Amazon RDS User Guide. This attribute is only supported in RDS for 1170 // Oracle. 1171 ReplicaMode ReplicaMode 1172 1173 // If present, specifies the name of the secondary Availability Zone for a DB 1174 // instance with multi-AZ support. 1175 SecondaryAvailabilityZone *string 1176 1177 // The status of a read replica. If the instance isn't a read replica, this is 1178 // blank. 1179 StatusInfos []DBInstanceStatusInfo 1180 1181 // Specifies whether the DB instance is encrypted. 1182 StorageEncrypted bool 1183 1184 // Specifies the storage type associated with DB instance. 1185 StorageType *string 1186 1187 // A list of tags. For more information, see Tagging Amazon RDS Resources 1188 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in 1189 // the Amazon RDS User Guide. 1190 TagList []Tag 1191 1192 // The ARN from the key store with which the instance is associated for TDE 1193 // encryption. 1194 TdeCredentialArn *string 1195 1196 // The time zone of the DB instance. In most cases, the Timezone element is empty. 1197 // Timezone content appears only for Microsoft SQL Server DB instances that were 1198 // created with a time zone specified. 1199 Timezone *string 1200 1201 // Provides a list of VPC security group elements that the DB instance belongs to. 1202 VpcSecurityGroups []VpcSecurityGroupMembership 1203} 1204 1205// An automated backup of a DB instance. It consists of system backups, transaction 1206// logs, and the database instance properties that existed at the time you deleted 1207// the source instance. 1208type DBInstanceAutomatedBackup struct { 1209 1210 // Specifies the allocated storage size in gibibytes (GiB). 1211 AllocatedStorage int32 1212 1213 // The Availability Zone that the automated backup was created in. For information 1214 // on AWS Regions and Availability Zones, see Regions and Availability Zones 1215 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). 1216 AvailabilityZone *string 1217 1218 // The retention period for the automated backups. 1219 BackupRetentionPeriod *int32 1220 1221 // The Amazon Resource Name (ARN) for the automated backups. 1222 DBInstanceArn *string 1223 1224 // The Amazon Resource Name (ARN) for the replicated automated backups. 1225 DBInstanceAutomatedBackupsArn *string 1226 1227 // The list of replications to different AWS Regions associated with the automated 1228 // backup. 1229 DBInstanceAutomatedBackupsReplications []DBInstanceAutomatedBackupsReplication 1230 1231 // The customer id of the instance that is/was associated with the automated 1232 // backup. 1233 DBInstanceIdentifier *string 1234 1235 // The identifier for the source DB instance, which can't be changed and which is 1236 // unique to an AWS Region. 1237 DbiResourceId *string 1238 1239 // Specifies whether the automated backup is encrypted. 1240 Encrypted bool 1241 1242 // The name of the database engine for this automated backup. 1243 Engine *string 1244 1245 // The version of the database engine for the automated backup. 1246 EngineVersion *string 1247 1248 // True if mapping of AWS Identity and Access Management (IAM) accounts to database 1249 // accounts is enabled, and otherwise false. 1250 IAMDatabaseAuthenticationEnabled bool 1251 1252 // Provides the date and time that the DB instance was created. 1253 InstanceCreateTime *time.Time 1254 1255 // The IOPS (I/O operations per second) value for the automated backup. 1256 Iops *int32 1257 1258 // The AWS KMS key ID for an automated backup. The AWS KMS key identifier is the 1259 // key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key 1260 // (CMK). 1261 KmsKeyId *string 1262 1263 // License model information for the automated backup. 1264 LicenseModel *string 1265 1266 // The license model of an automated backup. 1267 MasterUsername *string 1268 1269 // The option group the automated backup is associated with. If omitted, the 1270 // default option group for the engine specified is used. 1271 OptionGroupName *string 1272 1273 // The port number that the automated backup used for connections. Default: 1274 // Inherits from the source DB instance Valid Values: 1150-65535 1275 Port int32 1276 1277 // The AWS Region associated with the automated backup. 1278 Region *string 1279 1280 // Earliest and latest time an instance can be restored to. 1281 RestoreWindow *RestoreWindow 1282 1283 // Provides a list of status information for an automated backup: 1284 // 1285 // * active - 1286 // automated backups for current instances 1287 // 1288 // * retained - automated backups for 1289 // deleted instances 1290 // 1291 // * creating - automated backups that are waiting for the first 1292 // automated snapshot to be available. 1293 Status *string 1294 1295 // Specifies the storage type associated with the automated backup. 1296 StorageType *string 1297 1298 // The ARN from the key store with which the automated backup is associated for TDE 1299 // encryption. 1300 TdeCredentialArn *string 1301 1302 // The time zone of the automated backup. In most cases, the Timezone element is 1303 // empty. Timezone content appears only for Microsoft SQL Server DB instances that 1304 // were created with a time zone specified. 1305 Timezone *string 1306 1307 // Provides the VPC ID associated with the DB instance 1308 VpcId *string 1309} 1310 1311// Automated backups of a DB instance replicated to another AWS Region. They 1312// consist of system backups, transaction logs, and database instance properties. 1313type DBInstanceAutomatedBackupsReplication struct { 1314 1315 // The Amazon Resource Name (ARN) of the replicated automated backups. 1316 DBInstanceAutomatedBackupsArn *string 1317} 1318 1319// Describes an AWS Identity and Access Management (IAM) role that is associated 1320// with a DB instance. 1321type DBInstanceRole struct { 1322 1323 // The name of the feature associated with the AWS Identity and Access Management 1324 // (IAM) role. For the list of supported feature names, see DBEngineVersion. 1325 FeatureName *string 1326 1327 // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB 1328 // instance. 1329 RoleArn *string 1330 1331 // Describes the state of association between the IAM role and the DB instance. The 1332 // Status property returns one of the following values: 1333 // 1334 // * ACTIVE - the IAM role 1335 // ARN is associated with the DB instance and can be used to access other AWS 1336 // services on your behalf. 1337 // 1338 // * PENDING - the IAM role ARN is being associated with 1339 // the DB instance. 1340 // 1341 // * INVALID - the IAM role ARN is associated with the DB 1342 // instance, but the DB instance is unable to assume the IAM role in order to 1343 // access other AWS services on your behalf. 1344 Status *string 1345} 1346 1347// Provides a list of status information for a DB instance. 1348type DBInstanceStatusInfo struct { 1349 1350 // Details of the error if there is an error for the instance. If the instance 1351 // isn't in an error state, this value is blank. 1352 Message *string 1353 1354 // Boolean value that is true if the instance is operating normally, or false if 1355 // the instance is in an error state. 1356 Normal bool 1357 1358 // Status of the DB instance. For a StatusType of read replica, the values can be 1359 // replicating, replication stop point set, replication stop point reached, error, 1360 // stopped, or terminated. 1361 Status *string 1362 1363 // This value is currently "read replication." 1364 StatusType *string 1365} 1366 1367// Contains the details of an Amazon RDS DB parameter group. This data type is used 1368// as a response element in the DescribeDBParameterGroups action. 1369type DBParameterGroup struct { 1370 1371 // The Amazon Resource Name (ARN) for the DB parameter group. 1372 DBParameterGroupArn *string 1373 1374 // The name of the DB parameter group family that this DB parameter group is 1375 // compatible with. 1376 DBParameterGroupFamily *string 1377 1378 // The name of the DB parameter group. 1379 DBParameterGroupName *string 1380 1381 // Provides the customer-specified description for this DB parameter group. 1382 Description *string 1383} 1384 1385// The status of the DB parameter group. This data type is used as a response 1386// element in the following actions: 1387// 1388// * CreateDBInstance 1389// 1390// * 1391// CreateDBInstanceReadReplica 1392// 1393// * DeleteDBInstance 1394// 1395// * ModifyDBInstance 1396// 1397// * 1398// RebootDBInstance 1399// 1400// * RestoreDBInstanceFromDBSnapshot 1401type DBParameterGroupStatus struct { 1402 1403 // The name of the DB parameter group. 1404 DBParameterGroupName *string 1405 1406 // The status of parameter updates. 1407 ParameterApplyStatus *string 1408} 1409 1410// The data structure representing a proxy managed by the RDS Proxy. This data type 1411// is used as a response element in the DescribeDBProxies action. 1412type DBProxy struct { 1413 1414 // One or more data structures specifying the authorization mechanism to connect to 1415 // the associated RDS DB instance or Aurora DB cluster. 1416 Auth []UserAuthConfigInfo 1417 1418 // The date and time when the proxy was first created. 1419 CreatedDate *time.Time 1420 1421 // The Amazon Resource Name (ARN) for the proxy. 1422 DBProxyArn *string 1423 1424 // The identifier for the proxy. This name must be unique for all proxies owned by 1425 // your AWS account in the specified AWS Region. 1426 DBProxyName *string 1427 1428 // Whether the proxy includes detailed information about SQL statements in its 1429 // logs. This information helps you to debug issues involving SQL behavior or the 1430 // performance and scalability of the proxy connections. The debug information 1431 // includes the text of SQL statements that you submit through the proxy. Thus, 1432 // only enable this setting when needed for debugging, and only when you have 1433 // security measures in place to safeguard any sensitive information that appears 1434 // in the logs. 1435 DebugLogging bool 1436 1437 // The endpoint that you can use to connect to the proxy. You include the endpoint 1438 // value in the connection string for a database client application. 1439 Endpoint *string 1440 1441 // The engine family applies to MySQL and PostgreSQL for both RDS and Aurora. 1442 EngineFamily *string 1443 1444 // The number of seconds a connection to the proxy can have no activity before the 1445 // proxy drops the client connection. The proxy keeps the underlying database 1446 // connection open and puts it back into the connection pool for reuse by later 1447 // connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 1448 IdleClientTimeout int32 1449 1450 // Indicates whether Transport Layer Security (TLS) encryption is required for 1451 // connections to the proxy. 1452 RequireTLS bool 1453 1454 // The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access 1455 // Amazon Secrets Manager. 1456 RoleArn *string 1457 1458 // The current status of this proxy. A status of available means the proxy is ready 1459 // to handle requests. Other values indicate that you must wait for the proxy to be 1460 // ready, or take some action to resolve an issue. 1461 Status DBProxyStatus 1462 1463 // The date and time when the proxy was last updated. 1464 UpdatedDate *time.Time 1465 1466 // Provides a list of VPC security groups that the proxy belongs to. 1467 VpcSecurityGroupIds []string 1468 1469 // The EC2 subnet IDs for the proxy. 1470 VpcSubnetIds []string 1471} 1472 1473// Contains the details for an RDS Proxy target. It represents an RDS DB instance 1474// or Aurora DB cluster that the proxy can connect to. One or more targets are 1475// associated with an RDS Proxy target group. This data type is used as a response 1476// element in the DescribeDBProxyTargets action. 1477type DBProxyTarget struct { 1478 1479 // The writer endpoint for the RDS DB instance or Aurora DB cluster. 1480 Endpoint *string 1481 1482 // The port that the RDS Proxy uses to connect to the target RDS DB instance or 1483 // Aurora DB cluster. 1484 Port int32 1485 1486 // The identifier representing the target. It can be the instance identifier for an 1487 // RDS DB instance, or the cluster identifier for an Aurora DB cluster. 1488 RdsResourceId *string 1489 1490 // The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster. 1491 TargetArn *string 1492 1493 // Information about the connection health of the RDS Proxy target. 1494 TargetHealth *TargetHealth 1495 1496 // The DB cluster identifier when the target represents an Aurora DB cluster. This 1497 // field is blank when the target represents an RDS DB instance. 1498 TrackedClusterId *string 1499 1500 // Specifies the kind of database, such as an RDS DB instance or an Aurora DB 1501 // cluster, that the target represents. 1502 Type TargetType 1503} 1504 1505// Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy 1506// can connect to. Currently, each target group is associated with exactly one RDS 1507// DB instance or Aurora DB cluster. This data type is used as a response element 1508// in the DescribeDBProxyTargetGroups action. 1509type DBProxyTargetGroup struct { 1510 1511 // The settings that determine the size and behavior of the connection pool for the 1512 // target group. 1513 ConnectionPoolConfig *ConnectionPoolConfigurationInfo 1514 1515 // The date and time when the target group was first created. 1516 CreatedDate *time.Time 1517 1518 // The identifier for the RDS proxy associated with this target group. 1519 DBProxyName *string 1520 1521 // Whether this target group is the first one used for connection requests by the 1522 // associated proxy. Because each proxy is currently associated with a single 1523 // target group, currently this setting is always true. 1524 IsDefault bool 1525 1526 // The current status of this target group. A status of available means the target 1527 // group is correctly associated with a database. Other values indicate that you 1528 // must wait for the target group to be ready, or take some action to resolve an 1529 // issue. 1530 Status *string 1531 1532 // The Amazon Resource Name (ARN) representing the target group. 1533 TargetGroupArn *string 1534 1535 // The identifier for the target group. This name must be unique for all target 1536 // groups owned by your AWS account in the specified AWS Region. 1537 TargetGroupName *string 1538 1539 // The date and time when the target group was last updated. 1540 UpdatedDate *time.Time 1541} 1542 1543// Contains the details for an Amazon RDS DB security group. This data type is used 1544// as a response element in the DescribeDBSecurityGroups action. 1545type DBSecurityGroup struct { 1546 1547 // The Amazon Resource Name (ARN) for the DB security group. 1548 DBSecurityGroupArn *string 1549 1550 // Provides the description of the DB security group. 1551 DBSecurityGroupDescription *string 1552 1553 // Specifies the name of the DB security group. 1554 DBSecurityGroupName *string 1555 1556 // Contains a list of EC2SecurityGroup elements. 1557 EC2SecurityGroups []EC2SecurityGroup 1558 1559 // Contains a list of IPRange elements. 1560 IPRanges []IPRange 1561 1562 // Provides the AWS ID of the owner of a specific DB security group. 1563 OwnerId *string 1564 1565 // Provides the VpcId of the DB security group. 1566 VpcId *string 1567} 1568 1569// This data type is used as a response element in the following actions: 1570// 1571// * 1572// ModifyDBInstance 1573// 1574// * RebootDBInstance 1575// 1576// * RestoreDBInstanceFromDBSnapshot 1577// 1578// * 1579// RestoreDBInstanceToPointInTime 1580type DBSecurityGroupMembership struct { 1581 1582 // The name of the DB security group. 1583 DBSecurityGroupName *string 1584 1585 // The status of the DB security group. 1586 Status *string 1587} 1588 1589// Contains the details of an Amazon RDS DB snapshot. This data type is used as a 1590// response element in the DescribeDBSnapshots action. 1591type DBSnapshot struct { 1592 1593 // Specifies the allocated storage size in gibibytes (GiB). 1594 AllocatedStorage int32 1595 1596 // Specifies the name of the Availability Zone the DB instance was located in at 1597 // the time of the DB snapshot. 1598 AvailabilityZone *string 1599 1600 // Specifies the DB instance identifier of the DB instance this DB snapshot was 1601 // created from. 1602 DBInstanceIdentifier *string 1603 1604 // The Amazon Resource Name (ARN) for the DB snapshot. 1605 DBSnapshotArn *string 1606 1607 // Specifies the identifier for the DB snapshot. 1608 DBSnapshotIdentifier *string 1609 1610 // The identifier for the source DB instance, which can't be changed and which is 1611 // unique to an AWS Region. 1612 DbiResourceId *string 1613 1614 // Specifies whether the DB snapshot is encrypted. 1615 Encrypted bool 1616 1617 // Specifies the name of the database engine. 1618 Engine *string 1619 1620 // Specifies the version of the database engine. 1621 EngineVersion *string 1622 1623 // True if mapping of AWS Identity and Access Management (IAM) accounts to database 1624 // accounts is enabled, and otherwise false. 1625 IAMDatabaseAuthenticationEnabled bool 1626 1627 // Specifies the time in Coordinated Universal Time (UTC) when the DB instance, 1628 // from which the snapshot was taken, was created. 1629 InstanceCreateTime *time.Time 1630 1631 // Specifies the Provisioned IOPS (I/O operations per second) value of the DB 1632 // instance at the time of the snapshot. 1633 Iops *int32 1634 1635 // If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot. 1636 // The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for 1637 // the AWS KMS customer master key (CMK). 1638 KmsKeyId *string 1639 1640 // License model information for the restored DB instance. 1641 LicenseModel *string 1642 1643 // Provides the master username for the DB snapshot. 1644 MasterUsername *string 1645 1646 // Provides the option group name for the DB snapshot. 1647 OptionGroupName *string 1648 1649 // The percentage of the estimated data that has been transferred. 1650 PercentProgress int32 1651 1652 // Specifies the port that the database engine was listening on at the time of the 1653 // snapshot. 1654 Port int32 1655 1656 // The number of CPU cores and the number of threads per core for the DB instance 1657 // class of the DB instance when the DB snapshot was created. 1658 ProcessorFeatures []ProcessorFeature 1659 1660 // Specifies when the snapshot was taken in Coordinated Universal Time (UTC). 1661 SnapshotCreateTime *time.Time 1662 1663 // Provides the type of the DB snapshot. 1664 SnapshotType *string 1665 1666 // The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. 1667 // It only has value in case of cross-customer or cross-region copy. 1668 SourceDBSnapshotIdentifier *string 1669 1670 // The AWS Region that the DB snapshot was created in or copied from. 1671 SourceRegion *string 1672 1673 // Specifies the status of this DB snapshot. 1674 Status *string 1675 1676 // Specifies the storage type associated with DB snapshot. 1677 StorageType *string 1678 1679 // A list of tags. For more information, see Tagging Amazon RDS Resources 1680 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in 1681 // the Amazon RDS User Guide. 1682 TagList []Tag 1683 1684 // The ARN from the key store with which to associate the instance for TDE 1685 // encryption. 1686 TdeCredentialArn *string 1687 1688 // The time zone of the DB snapshot. In most cases, the Timezone element is empty. 1689 // Timezone content appears only for snapshots taken from Microsoft SQL Server DB 1690 // instances that were created with a time zone specified. 1691 Timezone *string 1692 1693 // Provides the VPC ID associated with the DB snapshot. 1694 VpcId *string 1695} 1696 1697// Contains the name and values of a manual DB snapshot attribute Manual DB 1698// snapshot attributes are used to authorize other AWS accounts to restore a manual 1699// DB snapshot. For more information, see the ModifyDBSnapshotAttribute API. 1700type DBSnapshotAttribute struct { 1701 1702 // The name of the manual DB snapshot attribute. The attribute named restore refers 1703 // to the list of AWS accounts that have permission to copy or restore the manual 1704 // DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API 1705 // action. 1706 AttributeName *string 1707 1708 // The value or values for the manual DB snapshot attribute. If the AttributeName 1709 // field is set to restore, then this element returns a list of IDs of the AWS 1710 // accounts that are authorized to copy or restore the manual DB snapshot. If a 1711 // value of all is in the list, then the manual DB snapshot is public and available 1712 // for any AWS account to copy or restore. 1713 AttributeValues []string 1714} 1715 1716// Contains the results of a successful call to the DescribeDBSnapshotAttributes 1717// API action. Manual DB snapshot attributes are used to authorize other AWS 1718// accounts to copy or restore a manual DB snapshot. For more information, see the 1719// ModifyDBSnapshotAttribute API action. 1720type DBSnapshotAttributesResult struct { 1721 1722 // The list of attributes and values for the manual DB snapshot. 1723 DBSnapshotAttributes []DBSnapshotAttribute 1724 1725 // The identifier of the manual DB snapshot that the attributes apply to. 1726 DBSnapshotIdentifier *string 1727} 1728 1729// Contains the details of an Amazon RDS DB subnet group. This data type is used as 1730// a response element in the DescribeDBSubnetGroups action. 1731type DBSubnetGroup struct { 1732 1733 // The Amazon Resource Name (ARN) for the DB subnet group. 1734 DBSubnetGroupArn *string 1735 1736 // Provides the description of the DB subnet group. 1737 DBSubnetGroupDescription *string 1738 1739 // The name of the DB subnet group. 1740 DBSubnetGroupName *string 1741 1742 // Provides the status of the DB subnet group. 1743 SubnetGroupStatus *string 1744 1745 // Contains a list of Subnet elements. 1746 Subnets []Subnet 1747 1748 // Provides the VpcId of the DB subnet group. 1749 VpcId *string 1750} 1751 1752// This data type is used as a response element to DescribeDBLogFiles. 1753type DescribeDBLogFilesDetails struct { 1754 1755 // A POSIX timestamp when the last log entry was written. 1756 LastWritten int64 1757 1758 // The name of the log file for the specified DB instance. 1759 LogFileName *string 1760 1761 // The size, in bytes, of the log file for the specified DB instance. 1762 Size int64 1763} 1764 1765// An Active Directory Domain membership record associated with the DB instance or 1766// cluster. 1767type DomainMembership struct { 1768 1769 // The identifier of the Active Directory Domain. 1770 Domain *string 1771 1772 // The fully qualified domain name of the Active Directory Domain. 1773 FQDN *string 1774 1775 // The name of the IAM role to be used when making API calls to the Directory 1776 // Service. 1777 IAMRoleName *string 1778 1779 // The status of the Active Directory Domain membership for the DB instance or 1780 // cluster. Values include joined, pending-join, failed, and so on. 1781 Status *string 1782} 1783 1784// A range of double values. 1785type DoubleRange struct { 1786 1787 // The minimum value in the range. 1788 From float64 1789 1790 // The maximum value in the range. 1791 To float64 1792} 1793 1794// This data type is used as a response element in the following actions: 1795// 1796// * 1797// AuthorizeDBSecurityGroupIngress 1798// 1799// * DescribeDBSecurityGroups 1800// 1801// * 1802// RevokeDBSecurityGroupIngress 1803type EC2SecurityGroup struct { 1804 1805 // Specifies the id of the EC2 security group. 1806 EC2SecurityGroupId *string 1807 1808 // Specifies the name of the EC2 security group. 1809 EC2SecurityGroupName *string 1810 1811 // Specifies the AWS ID of the owner of the EC2 security group specified in the 1812 // EC2SecurityGroupName field. 1813 EC2SecurityGroupOwnerId *string 1814 1815 // Provides the status of the EC2 security group. Status can be "authorizing", 1816 // "authorized", "revoking", and "revoked". 1817 Status *string 1818} 1819 1820// This data type represents the information you need to connect to an Amazon RDS 1821// DB instance. This data type is used as a response element in the following 1822// actions: 1823// 1824// * CreateDBInstance 1825// 1826// * DescribeDBInstances 1827// 1828// * DeleteDBInstance 1829// 1830// For the 1831// data structure that represents Amazon Aurora DB cluster endpoints, see 1832// DBClusterEndpoint. 1833type Endpoint struct { 1834 1835 // Specifies the DNS address of the DB instance. 1836 Address *string 1837 1838 // Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. 1839 HostedZoneId *string 1840 1841 // Specifies the port that the database engine is listening on. 1842 Port int32 1843} 1844 1845// Contains the result of a successful invocation of the 1846// DescribeEngineDefaultParameters action. 1847type EngineDefaults struct { 1848 1849 // Specifies the name of the DB parameter group family that the engine default 1850 // parameters apply to. 1851 DBParameterGroupFamily *string 1852 1853 // An optional pagination token provided by a previous EngineDefaults request. If 1854 // this parameter is specified, the response includes only records beyond the 1855 // marker, up to the value specified by MaxRecords . 1856 Marker *string 1857 1858 // Contains a list of engine default parameters. 1859 Parameters []Parameter 1860} 1861 1862// This data type is used as a response element in the DescribeEvents action. 1863type Event struct { 1864 1865 // Specifies the date and time of the event. 1866 Date *time.Time 1867 1868 // Specifies the category for the event. 1869 EventCategories []string 1870 1871 // Provides the text of this event. 1872 Message *string 1873 1874 // The Amazon Resource Name (ARN) for the event. 1875 SourceArn *string 1876 1877 // Provides the identifier for the source of the event. 1878 SourceIdentifier *string 1879 1880 // Specifies the source type for this event. 1881 SourceType SourceType 1882} 1883 1884// Contains the results of a successful invocation of the DescribeEventCategories 1885// operation. 1886type EventCategoriesMap struct { 1887 1888 // The event categories for the specified source type 1889 EventCategories []string 1890 1891 // The source type that the returned categories belong to 1892 SourceType *string 1893} 1894 1895// Contains the results of a successful invocation of the 1896// DescribeEventSubscriptions action. 1897type EventSubscription struct { 1898 1899 // The RDS event notification subscription Id. 1900 CustSubscriptionId *string 1901 1902 // The AWS customer account associated with the RDS event notification 1903 // subscription. 1904 CustomerAwsId *string 1905 1906 // A Boolean value indicating if the subscription is enabled. True indicates the 1907 // subscription is enabled. 1908 Enabled bool 1909 1910 // A list of event categories for the RDS event notification subscription. 1911 EventCategoriesList []string 1912 1913 // The Amazon Resource Name (ARN) for the event subscription. 1914 EventSubscriptionArn *string 1915 1916 // The topic ARN of the RDS event notification subscription. 1917 SnsTopicArn *string 1918 1919 // A list of source IDs for the RDS event notification subscription. 1920 SourceIdsList []string 1921 1922 // The source type for the RDS event notification subscription. 1923 SourceType *string 1924 1925 // The status of the RDS event notification subscription. Constraints: Can be one 1926 // of the following: creating | modifying | deleting | active | no-permission | 1927 // topic-not-exist The status "no-permission" indicates that RDS no longer has 1928 // permission to post to the SNS topic. The status "topic-not-exist" indicates that 1929 // the topic was deleted after the subscription was created. 1930 Status *string 1931 1932 // The time the RDS event notification subscription was created. 1933 SubscriptionCreationTime *string 1934} 1935 1936// Contains the details of a snapshot export to Amazon S3. This data type is used 1937// as a response element in the DescribeExportTasks action. 1938type ExportTask struct { 1939 1940 // The data exported from the snapshot. Valid values are the following: 1941 // 1942 // * database 1943 // - Export all the data from a specified database. 1944 // 1945 // * database.table table-name - 1946 // Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS 1947 // for MariaDB, and Aurora MySQL. 1948 // 1949 // * database.schema schema-name - Export a 1950 // database schema of the snapshot. This format is valid only for RDS for 1951 // PostgreSQL and Aurora PostgreSQL. 1952 // 1953 // * database.schema.table table-name - Export a 1954 // table of the database schema. This format is valid only for RDS for PostgreSQL 1955 // and Aurora PostgreSQL. 1956 ExportOnly []string 1957 1958 // A unique identifier for the snapshot export task. This ID isn't an identifier 1959 // for the Amazon S3 bucket where the snapshot is exported to. 1960 ExportTaskIdentifier *string 1961 1962 // The reason the export failed, if it failed. 1963 FailureCause *string 1964 1965 // The name of the IAM role that is used to write to Amazon S3 when exporting a 1966 // snapshot. 1967 IamRoleArn *string 1968 1969 // The key identifier of the AWS KMS customer master key (CMK) that is used to 1970 // encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK identifier 1971 // is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the 1972 // snapshot export must have encryption and decryption permissions to use this AWS 1973 // KMS CMK. 1974 KmsKeyId *string 1975 1976 // The progress of the snapshot export task as a percentage. 1977 PercentProgress int32 1978 1979 // The Amazon S3 bucket that the snapshot is exported to. 1980 S3Bucket *string 1981 1982 // The Amazon S3 bucket prefix that is the file name and path of the exported 1983 // snapshot. 1984 S3Prefix *string 1985 1986 // The time that the snapshot was created. 1987 SnapshotTime *time.Time 1988 1989 // The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3. 1990 SourceArn *string 1991 1992 // The progress status of the export task. 1993 Status *string 1994 1995 // The time that the snapshot export task completed. 1996 TaskEndTime *time.Time 1997 1998 // The time that the snapshot export task started. 1999 TaskStartTime *time.Time 2000 2001 // The total amount of data exported, in gigabytes. 2002 TotalExtractedDataInGB int32 2003 2004 // A warning about the snapshot export task. 2005 WarningMessage *string 2006} 2007 2008// A filter name and value pair that is used to return a more specific list of 2009// results from a describe operation. Filters can be used to match a set of 2010// resources by specific criteria, such as IDs. The filters supported by a describe 2011// operation are documented with the describe operation. Currently, wildcards are 2012// not supported in filters. The following actions can be filtered: 2013// 2014// * 2015// DescribeDBClusterBacktracks 2016// 2017// * DescribeDBClusterEndpoints 2018// 2019// * 2020// DescribeDBClusters 2021// 2022// * DescribeDBInstances 2023// 2024// * DescribePendingMaintenanceActions 2025type Filter struct { 2026 2027 // The name of the filter. Filter names are case-sensitive. 2028 // 2029 // This member is required. 2030 Name *string 2031 2032 // One or more filter values. Filter values are case-sensitive. 2033 // 2034 // This member is required. 2035 Values []string 2036} 2037 2038// A data type representing an Aurora global database. 2039type GlobalCluster struct { 2040 2041 // The default database name within the new global database cluster. 2042 DatabaseName *string 2043 2044 // The deletion protection setting for the new global database cluster. 2045 DeletionProtection *bool 2046 2047 // The Aurora database engine used by the global database cluster. 2048 Engine *string 2049 2050 // Indicates the database engine version. 2051 EngineVersion *string 2052 2053 // The Amazon Resource Name (ARN) for the global database cluster. 2054 GlobalClusterArn *string 2055 2056 // Contains a user-supplied global database cluster identifier. This identifier is 2057 // the unique key that identifies a global database cluster. 2058 GlobalClusterIdentifier *string 2059 2060 // The list of cluster IDs for secondary clusters within the global database 2061 // cluster. Currently limited to 1 item. 2062 GlobalClusterMembers []GlobalClusterMember 2063 2064 // The AWS Region-unique, immutable identifier for the global database cluster. 2065 // This identifier is found in AWS CloudTrail log entries whenever the AWS KMS 2066 // customer master key (CMK) for the DB cluster is accessed. 2067 GlobalClusterResourceId *string 2068 2069 // Specifies the current state of this global database cluster. 2070 Status *string 2071 2072 // The storage encryption setting for the global database cluster. 2073 StorageEncrypted *bool 2074} 2075 2076// A data structure with information about any primary and secondary clusters 2077// associated with an Aurora global database. 2078type GlobalClusterMember struct { 2079 2080 // The Amazon Resource Name (ARN) for each Aurora cluster. 2081 DBClusterArn *string 2082 2083 // Specifies whether a secondary cluster in an Aurora global database has write 2084 // forwarding enabled, not enabled, or is in the process of enabling it. 2085 GlobalWriteForwardingStatus WriteForwardingStatus 2086 2087 // Specifies whether the Aurora cluster is the primary cluster (that is, has 2088 // read-write capability) for the Aurora global database with which it is 2089 // associated. 2090 IsWriter bool 2091 2092 // The Amazon Resource Name (ARN) for each read-only secondary cluster associated 2093 // with the Aurora global database. 2094 Readers []string 2095} 2096 2097// Contains the installation media for a DB engine that requires an on-premises 2098// customer provided license, such as Microsoft SQL Server. 2099type InstallationMedia struct { 2100 2101 // The custom Availability Zone (AZ) that contains the installation media. 2102 CustomAvailabilityZoneId *string 2103 2104 // The DB engine. 2105 Engine *string 2106 2107 // The path to the installation medium for the DB engine. 2108 EngineInstallationMediaPath *string 2109 2110 // The engine version of the DB engine. 2111 EngineVersion *string 2112 2113 // If an installation media failure occurred, the cause of the failure. 2114 FailureCause *InstallationMediaFailureCause 2115 2116 // The installation medium ID. 2117 InstallationMediaId *string 2118 2119 // The path to the installation medium for the operating system associated with the 2120 // DB engine. 2121 OSInstallationMediaPath *string 2122 2123 // The status of the installation medium. 2124 Status *string 2125} 2126 2127// Contains the cause of an installation media failure. Installation media is used 2128// for a DB engine that requires an on-premises customer provided license, such as 2129// Microsoft SQL Server. 2130type InstallationMediaFailureCause struct { 2131 2132 // The reason that an installation media import failed. 2133 Message *string 2134} 2135 2136// This data type is used as a response element in the DescribeDBSecurityGroups 2137// action. 2138type IPRange struct { 2139 2140 // Specifies the IP range. 2141 CIDRIP *string 2142 2143 // Specifies the status of the IP range. Status can be "authorizing", "authorized", 2144 // "revoking", and "revoked". 2145 Status *string 2146} 2147 2148// The minimum DB engine version required for each corresponding allowed value for 2149// an option setting. 2150type MinimumEngineVersionPerAllowedValue struct { 2151 2152 // The allowed value for an option setting. 2153 AllowedValue *string 2154 2155 // The minimum DB engine version required for the allowed value. 2156 MinimumEngineVersion *string 2157} 2158 2159// Option details. 2160type Option struct { 2161 2162 // If the option requires access to a port, then this DB security group allows 2163 // access to the port. 2164 DBSecurityGroupMemberships []DBSecurityGroupMembership 2165 2166 // The description of the option. 2167 OptionDescription *string 2168 2169 // The name of the option. 2170 OptionName *string 2171 2172 // The option settings for this option. 2173 OptionSettings []OptionSetting 2174 2175 // The version of the option. 2176 OptionVersion *string 2177 2178 // Indicate if this option is permanent. 2179 Permanent bool 2180 2181 // Indicate if this option is persistent. 2182 Persistent bool 2183 2184 // If required, the port configured for this option to use. 2185 Port *int32 2186 2187 // If the option requires access to a port, then this VPC security group allows 2188 // access to the port. 2189 VpcSecurityGroupMemberships []VpcSecurityGroupMembership 2190} 2191 2192// A list of all available options 2193type OptionConfiguration struct { 2194 2195 // The configuration of options to include in a group. 2196 // 2197 // This member is required. 2198 OptionName *string 2199 2200 // A list of DBSecurityGroupMembership name strings used for this option. 2201 DBSecurityGroupMemberships []string 2202 2203 // The option settings to include in an option group. 2204 OptionSettings []OptionSetting 2205 2206 // The version for the option. 2207 OptionVersion *string 2208 2209 // The optional port for the option. 2210 Port *int32 2211 2212 // A list of VpcSecurityGroupMembership name strings used for this option. 2213 VpcSecurityGroupMemberships []string 2214} 2215 2216// 2217type OptionGroup struct { 2218 2219 // Indicates whether this option group can be applied to both VPC and non-VPC 2220 // instances. The value true indicates the option group can be applied to both VPC 2221 // and non-VPC instances. 2222 AllowsVpcAndNonVpcInstanceMemberships bool 2223 2224 // Indicates the name of the engine that this option group can be applied to. 2225 EngineName *string 2226 2227 // Indicates the major engine version associated with this option group. 2228 MajorEngineVersion *string 2229 2230 // The Amazon Resource Name (ARN) for the option group. 2231 OptionGroupArn *string 2232 2233 // Provides a description of the option group. 2234 OptionGroupDescription *string 2235 2236 // Specifies the name of the option group. 2237 OptionGroupName *string 2238 2239 // Indicates what options are available in the option group. 2240 Options []Option 2241 2242 // If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If 2243 // AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this 2244 // option group can be applied to both VPC and non-VPC instances. If this field 2245 // contains a value, then this option group can only be applied to instances that 2246 // are in the VPC indicated by this field. 2247 VpcId *string 2248} 2249 2250// Provides information on the option groups the DB instance is a member of. 2251type OptionGroupMembership struct { 2252 2253 // The name of the option group that the instance belongs to. 2254 OptionGroupName *string 2255 2256 // The status of the DB instance's option group membership. Valid values are: 2257 // in-sync, pending-apply, pending-removal, pending-maintenance-apply, 2258 // pending-maintenance-removal, applying, removing, and failed. 2259 Status *string 2260} 2261 2262// Available option. 2263type OptionGroupOption struct { 2264 2265 // If the option requires a port, specifies the default port for the option. 2266 DefaultPort *int32 2267 2268 // The description of the option. 2269 Description *string 2270 2271 // The name of the engine that this option can be applied to. 2272 EngineName *string 2273 2274 // Indicates the major engine version that the option is available for. 2275 MajorEngineVersion *string 2276 2277 // The minimum required engine version for the option to be applied. 2278 MinimumRequiredMinorEngineVersion *string 2279 2280 // The name of the option. 2281 Name *string 2282 2283 // The option settings that are available (and the default value) for each option 2284 // in an option group. 2285 OptionGroupOptionSettings []OptionGroupOptionSetting 2286 2287 // The versions that are available for the option. 2288 OptionGroupOptionVersions []OptionVersion 2289 2290 // The options that conflict with this option. 2291 OptionsConflictsWith []string 2292 2293 // The options that are prerequisites for this option. 2294 OptionsDependedOn []string 2295 2296 // Permanent options can never be removed from an option group. An option group 2297 // containing a permanent option can't be removed from a DB instance. 2298 Permanent bool 2299 2300 // Persistent options can't be removed from an option group while DB instances are 2301 // associated with the option group. If you disassociate all DB instances from the 2302 // option group, your can remove the persistent option from the option group. 2303 Persistent bool 2304 2305 // Specifies whether the option requires a port. 2306 PortRequired bool 2307 2308 // If true, you must enable the Auto Minor Version Upgrade setting for your DB 2309 // instance before you can use this option. You can enable Auto Minor Version 2310 // Upgrade when you first create your DB instance, or by modifying your DB instance 2311 // later. 2312 RequiresAutoMinorEngineVersionUpgrade bool 2313 2314 // If true, you can change the option to an earlier version of the option. This 2315 // only applies to options that have different versions available. 2316 SupportsOptionVersionDowngrade *bool 2317 2318 // If true, you can only use this option with a DB instance that is in a VPC. 2319 VpcOnly bool 2320} 2321 2322// Option group option settings are used to display settings available for each 2323// option with their default values and other information. These values are used 2324// with the DescribeOptionGroupOptions action. 2325type OptionGroupOptionSetting struct { 2326 2327 // Indicates the acceptable values for the option group option. 2328 AllowedValues *string 2329 2330 // The DB engine specific parameter type for the option group option. 2331 ApplyType *string 2332 2333 // The default value for the option group option. 2334 DefaultValue *string 2335 2336 // Boolean value where true indicates that this option group option can be changed 2337 // from the default value. 2338 IsModifiable bool 2339 2340 // Boolean value where true indicates that a value must be specified for this 2341 // option setting of the option group option. 2342 IsRequired bool 2343 2344 // The minimum DB engine version required for the corresponding allowed value for 2345 // this option setting. 2346 MinimumEngineVersionPerAllowedValue []MinimumEngineVersionPerAllowedValue 2347 2348 // The description of the option group option. 2349 SettingDescription *string 2350 2351 // The name of the option group option. 2352 SettingName *string 2353} 2354 2355// Option settings are the actual settings being applied or configured for that 2356// option. It is used when you modify an option group or describe option groups. 2357// For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called 2358// SQLNET.ENCRYPTION_SERVER that can have several different values. 2359type OptionSetting struct { 2360 2361 // The allowed values of the option setting. 2362 AllowedValues *string 2363 2364 // The DB engine specific parameter type. 2365 ApplyType *string 2366 2367 // The data type of the option setting. 2368 DataType *string 2369 2370 // The default value of the option setting. 2371 DefaultValue *string 2372 2373 // The description of the option setting. 2374 Description *string 2375 2376 // Indicates if the option setting is part of a collection. 2377 IsCollection bool 2378 2379 // A Boolean value that, when true, indicates the option setting can be modified 2380 // from the default. 2381 IsModifiable bool 2382 2383 // The name of the option that has settings that you can set. 2384 Name *string 2385 2386 // The current value of the option setting. 2387 Value *string 2388} 2389 2390// The version for an option. Option group option versions are returned by the 2391// DescribeOptionGroupOptions action. 2392type OptionVersion struct { 2393 2394 // True if the version is the default version of the option, and otherwise false. 2395 IsDefault bool 2396 2397 // The version of the option. 2398 Version *string 2399} 2400 2401// Contains a list of available options for a DB instance. This data type is used 2402// as a response element in the DescribeOrderableDBInstanceOptions action. 2403type OrderableDBInstanceOption struct { 2404 2405 // The Availability Zone group for a DB instance. 2406 AvailabilityZoneGroup *string 2407 2408 // A list of Availability Zones for a DB instance. 2409 AvailabilityZones []AvailabilityZone 2410 2411 // A list of the available processor features for the DB instance class of a DB 2412 // instance. 2413 AvailableProcessorFeatures []AvailableProcessorFeature 2414 2415 // The DB instance class for a DB instance. 2416 DBInstanceClass *string 2417 2418 // The engine type of a DB instance. 2419 Engine *string 2420 2421 // The engine version of a DB instance. 2422 EngineVersion *string 2423 2424 // The license model for a DB instance. 2425 LicenseModel *string 2426 2427 // Maximum total provisioned IOPS for a DB instance. 2428 MaxIopsPerDbInstance *int32 2429 2430 // Maximum provisioned IOPS per GiB for a DB instance. 2431 MaxIopsPerGib *float64 2432 2433 // Maximum storage size for a DB instance. 2434 MaxStorageSize *int32 2435 2436 // Minimum total provisioned IOPS for a DB instance. 2437 MinIopsPerDbInstance *int32 2438 2439 // Minimum provisioned IOPS per GiB for a DB instance. 2440 MinIopsPerGib *float64 2441 2442 // Minimum storage size for a DB instance. 2443 MinStorageSize *int32 2444 2445 // Indicates whether a DB instance is Multi-AZ capable. 2446 MultiAZCapable bool 2447 2448 // Whether a DB instance supports RDS on Outposts. For more information about RDS 2449 // on Outposts, see Amazon RDS on AWS Outposts 2450 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in 2451 // the Amazon RDS User Guide. 2452 OutpostCapable bool 2453 2454 // Indicates whether a DB instance can have a read replica. 2455 ReadReplicaCapable bool 2456 2457 // Indicates the storage type for a DB instance. 2458 StorageType *string 2459 2460 // A list of the supported DB engine modes. 2461 SupportedEngineModes []string 2462 2463 // Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 2464 // to 60 seconds. 2465 SupportsEnhancedMonitoring bool 2466 2467 // A value that indicates whether you can use Aurora global databases with a 2468 // specific combination of other DB engine attributes. 2469 SupportsGlobalDatabases bool 2470 2471 // Indicates whether a DB instance supports IAM database authentication. 2472 SupportsIAMDatabaseAuthentication bool 2473 2474 // Indicates whether a DB instance supports provisioned IOPS. 2475 SupportsIops bool 2476 2477 // Whether a DB instance supports Kerberos Authentication. 2478 SupportsKerberosAuthentication *bool 2479 2480 // True if a DB instance supports Performance Insights, otherwise false. 2481 SupportsPerformanceInsights bool 2482 2483 // Whether Amazon RDS can automatically scale storage for DB instances that use the 2484 // specified DB instance class. 2485 SupportsStorageAutoscaling *bool 2486 2487 // Indicates whether a DB instance supports encrypted storage. 2488 SupportsStorageEncryption bool 2489 2490 // Indicates whether a DB instance is in a VPC. 2491 Vpc bool 2492} 2493 2494// A data type that represents an Outpost. For more information about RDS on 2495// Outposts, see Amazon RDS on AWS Outposts 2496// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in 2497// the Amazon RDS User Guide. 2498type Outpost struct { 2499 2500 // The Amazon Resource Name (ARN) of the Outpost. 2501 Arn *string 2502} 2503 2504// This data type is used as a request parameter in the ModifyDBParameterGroup and 2505// ResetDBParameterGroup actions. This data type is used as a response element in 2506// the DescribeEngineDefaultParameters and DescribeDBParameters actions. 2507type Parameter struct { 2508 2509 // Specifies the valid range of values for the parameter. 2510 AllowedValues *string 2511 2512 // Indicates when to apply parameter updates. 2513 ApplyMethod ApplyMethod 2514 2515 // Specifies the engine specific parameters type. 2516 ApplyType *string 2517 2518 // Specifies the valid data type for the parameter. 2519 DataType *string 2520 2521 // Provides a description of the parameter. 2522 Description *string 2523 2524 // Indicates whether (true) or not (false) the parameter can be modified. Some 2525 // parameters have security or operational implications that prevent them from 2526 // being changed. 2527 IsModifiable bool 2528 2529 // The earliest engine version to which the parameter can apply. 2530 MinimumEngineVersion *string 2531 2532 // Specifies the name of the parameter. 2533 ParameterName *string 2534 2535 // Specifies the value of the parameter. 2536 ParameterValue *string 2537 2538 // Indicates the source of the parameter value. 2539 Source *string 2540 2541 // The valid DB engine modes. 2542 SupportedEngineModes []string 2543} 2544 2545// A list of the log types whose configuration is still pending. In other words, 2546// these log types are in the process of being activated or deactivated. 2547type PendingCloudwatchLogsExports struct { 2548 2549 // Log types that are in the process of being enabled. After they are enabled, 2550 // these log types are exported to CloudWatch Logs. 2551 LogTypesToDisable []string 2552 2553 // Log types that are in the process of being deactivated. After they are 2554 // deactivated, these log types aren't exported to CloudWatch Logs. 2555 LogTypesToEnable []string 2556} 2557 2558// Provides information about a pending maintenance action for a resource. 2559type PendingMaintenanceAction struct { 2560 2561 // The type of pending maintenance action that is available for the resource. Valid 2562 // actions are system-update, db-upgrade, hardware-maintenance, and 2563 // ca-certificate-rotation. 2564 Action *string 2565 2566 // The date of the maintenance window when the action is applied. The maintenance 2567 // action is applied to the resource during its first maintenance window after this 2568 // date. 2569 AutoAppliedAfterDate *time.Time 2570 2571 // The effective date when the pending maintenance action is applied to the 2572 // resource. This date takes into account opt-in requests received from the 2573 // ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the 2574 // ForcedApplyDate. This value is blank if an opt-in request has not been received 2575 // and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate. 2576 CurrentApplyDate *time.Time 2577 2578 // A description providing more detail about the maintenance action. 2579 Description *string 2580 2581 // The date when the maintenance action is automatically applied. On this date, the 2582 // maintenance action is applied to the resource as soon as possible, regardless of 2583 // the maintenance window for the resource. There might be a delay of one or more 2584 // days from this date before the maintenance action is applied. 2585 ForcedApplyDate *time.Time 2586 2587 // Indicates the type of opt-in request that has been received for the resource. 2588 OptInStatus *string 2589} 2590 2591// This data type is used as a response element in the ModifyDBInstance action and 2592// contains changes that will be applied during the next maintenance window. 2593type PendingModifiedValues struct { 2594 2595 // The allocated storage size for the DB instance specified in gibibytes . 2596 AllocatedStorage *int32 2597 2598 // The number of days for which automated backups are retained. 2599 BackupRetentionPeriod *int32 2600 2601 // The identifier of the CA certificate for the DB instance. 2602 CACertificateIdentifier *string 2603 2604 // The name of the compute and memory capacity class for the DB instance. 2605 DBInstanceClass *string 2606 2607 // The database identifier for the DB instance. 2608 DBInstanceIdentifier *string 2609 2610 // The DB subnet group for the DB instance. 2611 DBSubnetGroupName *string 2612 2613 // The database engine version. 2614 EngineVersion *string 2615 2616 // Whether mapping of AWS Identity and Access Management (IAM) accounts to database 2617 // accounts is enabled. 2618 IAMDatabaseAuthenticationEnabled *bool 2619 2620 // The Provisioned IOPS value for the DB instance. 2621 Iops *int32 2622 2623 // The license model for the DB instance. Valid values: license-included | 2624 // bring-your-own-license | general-public-license 2625 LicenseModel *string 2626 2627 // The master credentials for the DB instance. 2628 MasterUserPassword *string 2629 2630 // Indicates that the Single-AZ DB instance will change to a Multi-AZ deployment. 2631 MultiAZ *bool 2632 2633 // A list of the log types whose configuration is still pending. In other words, 2634 // these log types are in the process of being activated or deactivated. 2635 PendingCloudwatchLogsExports *PendingCloudwatchLogsExports 2636 2637 // The port for the DB instance. 2638 Port *int32 2639 2640 // The number of CPU cores and the number of threads per core for the DB instance 2641 // class of the DB instance. 2642 ProcessorFeatures []ProcessorFeature 2643 2644 // The storage type of the DB instance. 2645 StorageType *string 2646} 2647 2648// Contains the processor features of a DB instance class. To specify the number of 2649// CPU cores, use the coreCount feature name for the Name parameter. To specify the 2650// number of threads per core, use the threadsPerCore feature name for the Name 2651// parameter. You can set the processor features of the DB instance class for a DB 2652// instance when you call one of the following actions: 2653// 2654// * CreateDBInstance 2655// 2656// * 2657// ModifyDBInstance 2658// 2659// * RestoreDBInstanceFromDBSnapshot 2660// 2661// * 2662// RestoreDBInstanceFromS3 2663// 2664// * RestoreDBInstanceToPointInTime 2665// 2666// You can view the 2667// valid processor values for a particular instance class by calling the 2668// DescribeOrderableDBInstanceOptions action and specifying the instance class for 2669// the DBInstanceClass parameter. In addition, you can use the following actions 2670// for DB instance class processor information: 2671// 2672// * DescribeDBInstances 2673// 2674// * 2675// DescribeDBSnapshots 2676// 2677// * DescribeValidDBInstanceModifications 2678// 2679// If you call 2680// DescribeDBInstances, ProcessorFeature returns non-null values only if the 2681// following conditions are met: 2682// 2683// * You are accessing an Oracle DB instance. 2684// 2685// * 2686// Your Oracle DB instance class supports configuring the number of CPU cores and 2687// threads per core. 2688// 2689// * The current number CPU cores and threads is set to a 2690// non-default value. 2691// 2692// For more information, see Configuring the Processor of the 2693// DB Instance Class 2694// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor) 2695// in the Amazon RDS User Guide. 2696type ProcessorFeature struct { 2697 2698 // The name of the processor feature. Valid names are coreCount and threadsPerCore. 2699 Name *string 2700 2701 // The value of a processor feature name. 2702 Value *string 2703} 2704 2705// A range of integer values. 2706type Range struct { 2707 2708 // The minimum value in the range. 2709 From int32 2710 2711 // The step value for the range. For example, if you have a range of 5,000 to 2712 // 10,000, with a step value of 1,000, the valid values start at 5,000 and step up 2713 // by 1,000. Even though 7,500 is within the range, it isn't a valid value for the 2714 // range. The valid values are 5,000, 6,000, 7,000, 8,000... 2715 Step *int32 2716 2717 // The maximum value in the range. 2718 To int32 2719} 2720 2721// This data type is used as a response element in the DescribeReservedDBInstances 2722// and DescribeReservedDBInstancesOfferings actions. 2723type RecurringCharge struct { 2724 2725 // The amount of the recurring charge. 2726 RecurringChargeAmount float64 2727 2728 // The frequency of the recurring charge. 2729 RecurringChargeFrequency *string 2730} 2731 2732// This data type is used as a response element in the DescribeReservedDBInstances 2733// and PurchaseReservedDBInstancesOffering actions. 2734type ReservedDBInstance struct { 2735 2736 // The currency code for the reserved DB instance. 2737 CurrencyCode *string 2738 2739 // The DB instance class for the reserved DB instance. 2740 DBInstanceClass *string 2741 2742 // The number of reserved DB instances. 2743 DBInstanceCount int32 2744 2745 // The duration of the reservation in seconds. 2746 Duration int32 2747 2748 // The fixed price charged for this reserved DB instance. 2749 FixedPrice float64 2750 2751 // The unique identifier for the lease associated with the reserved DB instance. 2752 // AWS Support might request the lease ID for an issue related to a reserved DB 2753 // instance. 2754 LeaseId *string 2755 2756 // Indicates if the reservation applies to Multi-AZ deployments. 2757 MultiAZ bool 2758 2759 // The offering type of this reserved DB instance. 2760 OfferingType *string 2761 2762 // The description of the reserved DB instance. 2763 ProductDescription *string 2764 2765 // The recurring price charged to run this reserved DB instance. 2766 RecurringCharges []RecurringCharge 2767 2768 // The Amazon Resource Name (ARN) for the reserved DB instance. 2769 ReservedDBInstanceArn *string 2770 2771 // The unique identifier for the reservation. 2772 ReservedDBInstanceId *string 2773 2774 // The offering identifier. 2775 ReservedDBInstancesOfferingId *string 2776 2777 // The time the reservation started. 2778 StartTime *time.Time 2779 2780 // The state of the reserved DB instance. 2781 State *string 2782 2783 // The hourly price charged for this reserved DB instance. 2784 UsagePrice float64 2785} 2786 2787// This data type is used as a response element in the 2788// DescribeReservedDBInstancesOfferings action. 2789type ReservedDBInstancesOffering struct { 2790 2791 // The currency code for the reserved DB instance offering. 2792 CurrencyCode *string 2793 2794 // The DB instance class for the reserved DB instance. 2795 DBInstanceClass *string 2796 2797 // The duration of the offering in seconds. 2798 Duration int32 2799 2800 // The fixed price charged for this offering. 2801 FixedPrice float64 2802 2803 // Indicates if the offering applies to Multi-AZ deployments. 2804 MultiAZ bool 2805 2806 // The offering type. 2807 OfferingType *string 2808 2809 // The database engine used by the offering. 2810 ProductDescription *string 2811 2812 // The recurring price charged to run this reserved DB instance. 2813 RecurringCharges []RecurringCharge 2814 2815 // The offering identifier. 2816 ReservedDBInstancesOfferingId *string 2817 2818 // The hourly price charged for this offering. 2819 UsagePrice float64 2820} 2821 2822// Describes the pending maintenance actions for a resource. 2823type ResourcePendingMaintenanceActions struct { 2824 2825 // A list that provides details about the pending maintenance actions for the 2826 // resource. 2827 PendingMaintenanceActionDetails []PendingMaintenanceAction 2828 2829 // The ARN of the resource that has pending maintenance actions. 2830 ResourceIdentifier *string 2831} 2832 2833// Earliest and latest time an instance can be restored to: 2834type RestoreWindow struct { 2835 2836 // The earliest time you can restore an instance to. 2837 EarliestTime *time.Time 2838 2839 // The latest time you can restore an instance to. 2840 LatestTime *time.Time 2841} 2842 2843// Contains the scaling configuration of an Aurora Serverless DB cluster. For more 2844// information, see Using Amazon Aurora Serverless 2845// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) 2846// in the Amazon Aurora User Guide. 2847type ScalingConfiguration struct { 2848 2849 // A value that indicates whether to allow or disallow automatic pause for an 2850 // Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only 2851 // when it's idle (it has no connections). If a DB cluster is paused for more than 2852 // seven days, the DB cluster might be backed up with a snapshot. In this case, the 2853 // DB cluster is restored when there is a request to connect to it. 2854 AutoPause *bool 2855 2856 // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. For 2857 // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. 2858 // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 2859 // 384. The maximum capacity must be greater than or equal to the minimum capacity. 2860 MaxCapacity *int32 2861 2862 // The minimum capacity for an Aurora DB cluster in serverless DB engine mode. For 2863 // Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. 2864 // For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 2865 // 384. The minimum capacity must be less than or equal to the maximum capacity. 2866 MinCapacity *int32 2867 2868 // The time, in seconds, before an Aurora DB cluster in serverless mode is paused. 2869 SecondsUntilAutoPause *int32 2870 2871 // The action to take when the timeout is reached, either ForceApplyCapacityChange 2872 // or RollbackCapacityChange. ForceApplyCapacityChange sets the capacity to the 2873 // specified value as soon as possible. RollbackCapacityChange, the default, 2874 // ignores the capacity change if a scaling point isn't found in the timeout 2875 // period. If you specify ForceApplyCapacityChange, connections that prevent Aurora 2876 // Serverless from finding a scaling point might be dropped. For more information, 2877 // see Autoscaling for Aurora Serverless 2878 // (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) 2879 // in the Amazon Aurora User Guide. 2880 TimeoutAction *string 2881} 2882 2883// Shows the scaling configuration for an Aurora DB cluster in serverless DB engine 2884// mode. For more information, see Using Amazon Aurora Serverless 2885// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) 2886// in the Amazon Aurora User Guide. 2887type ScalingConfigurationInfo struct { 2888 2889 // A value that indicates whether automatic pause is allowed for the Aurora DB 2890 // cluster in serverless DB engine mode. When the value is set to false for an 2891 // Aurora Serverless DB cluster, the DB cluster automatically resumes. 2892 AutoPause *bool 2893 2894 // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. 2895 MaxCapacity *int32 2896 2897 // The maximum capacity for the Aurora DB cluster in serverless DB engine mode. 2898 MinCapacity *int32 2899 2900 // The remaining amount of time, in seconds, before the Aurora DB cluster in 2901 // serverless mode is paused. A DB cluster can be paused only when it's idle (it 2902 // has no connections). 2903 SecondsUntilAutoPause *int32 2904 2905 // The timeout action of a call to ModifyCurrentDBClusterCapacity, either 2906 // ForceApplyCapacityChange or RollbackCapacityChange. 2907 TimeoutAction *string 2908} 2909 2910// Contains an AWS Region name as the result of a successful call to the 2911// DescribeSourceRegions action. 2912type SourceRegion struct { 2913 2914 // The endpoint for the source AWS Region endpoint. 2915 Endpoint *string 2916 2917 // The name of the source AWS Region. 2918 RegionName *string 2919 2920 // The status of the source AWS Region. 2921 Status *string 2922 2923 // Whether the source AWS Region supports replicating automated backups to the 2924 // current AWS Region. 2925 SupportsDBInstanceAutomatedBackupsReplication bool 2926} 2927 2928// This data type is used as a response element for the DescribeDBSubnetGroups 2929// operation. 2930type Subnet struct { 2931 2932 // Contains Availability Zone information. This data type is used as an element in 2933 // the OrderableDBInstanceOption data type. 2934 SubnetAvailabilityZone *AvailabilityZone 2935 2936 // The identifier of the subnet. 2937 SubnetIdentifier *string 2938 2939 // If the subnet is associated with an Outpost, this value specifies the Outpost. 2940 // For more information about RDS on Outposts, see Amazon RDS on AWS Outposts 2941 // (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in 2942 // the Amazon RDS User Guide. 2943 SubnetOutpost *Outpost 2944 2945 // The status of the subnet. 2946 SubnetStatus *string 2947} 2948 2949// Metadata assigned to an Amazon RDS resource consisting of a key-value pair. 2950type Tag struct { 2951 2952 // A key is the required name of the tag. The string value can be from 1 to 128 2953 // Unicode characters in length and can't be prefixed with "aws:" or "rds:". The 2954 // string can only contain only the set of Unicode letters, digits, white-space, 2955 // '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: 2956 // "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). 2957 Key *string 2958 2959 // A value is the optional value of the tag. The string value can be from 1 to 256 2960 // Unicode characters in length and can't be prefixed with "aws:" or "rds:". The 2961 // string can only contain only the set of Unicode letters, digits, white-space, 2962 // '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: 2963 // "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"). 2964 Value *string 2965} 2966 2967// Information about the connection health of an RDS Proxy target. 2968type TargetHealth struct { 2969 2970 // A description of the health of the RDS Proxy target. If the State is AVAILABLE, 2971 // a description is not included. 2972 Description *string 2973 2974 // The reason for the current health State of the RDS Proxy target. 2975 Reason TargetHealthReason 2976 2977 // The current state of the connection health lifecycle for the RDS Proxy target. 2978 // The following is a typical lifecycle example for the states of an RDS Proxy 2979 // target: registering > unavailable > available > unavailable > available 2980 State TargetState 2981} 2982 2983// A time zone associated with a DBInstance or a DBSnapshot. This data type is an 2984// element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and 2985// the DescribeDBEngineVersions actions. 2986type Timezone struct { 2987 2988 // The name of the time zone. 2989 TimezoneName *string 2990} 2991 2992// The version of the database engine that a DB instance can be upgraded to. 2993type UpgradeTarget struct { 2994 2995 // A value that indicates whether the target version is applied to any source DB 2996 // instances that have AutoMinorVersionUpgrade set to true. 2997 AutoUpgrade bool 2998 2999 // The version of the database engine that a DB instance can be upgraded to. 3000 Description *string 3001 3002 // The name of the upgrade target database engine. 3003 Engine *string 3004 3005 // The version number of the upgrade target database engine. 3006 EngineVersion *string 3007 3008 // A value that indicates whether a database engine is upgraded to a major version. 3009 IsMajorVersionUpgrade bool 3010} 3011 3012// Specifies the details of authentication used by a proxy to log in as a specific 3013// database user. 3014type UserAuthConfig struct { 3015 3016 // The type of authentication that the proxy uses for connections from the proxy to 3017 // the underlying database. 3018 AuthScheme AuthScheme 3019 3020 // A user-specified description about the authentication used by a proxy to log in 3021 // as a specific database user. 3022 Description *string 3023 3024 // Whether to require or disallow AWS Identity and Access Management (IAM) 3025 // authentication for connections to the proxy. 3026 IAMAuth IAMAuthMode 3027 3028 // The Amazon Resource Name (ARN) representing the secret that the proxy uses to 3029 // authenticate to the RDS DB instance or Aurora DB cluster. These secrets are 3030 // stored within Amazon Secrets Manager. 3031 SecretArn *string 3032 3033 // The name of the database user to which the proxy connects. 3034 UserName *string 3035} 3036 3037// Returns the details of authentication used by a proxy to log in as a specific 3038// database user. 3039type UserAuthConfigInfo struct { 3040 3041 // The type of authentication that the proxy uses for connections from the proxy to 3042 // the underlying database. 3043 AuthScheme AuthScheme 3044 3045 // A user-specified description about the authentication used by a proxy to log in 3046 // as a specific database user. 3047 Description *string 3048 3049 // Whether to require or disallow AWS Identity and Access Management (IAM) 3050 // authentication for connections to the proxy. 3051 IAMAuth IAMAuthMode 3052 3053 // The Amazon Resource Name (ARN) representing the secret that the proxy uses to 3054 // authenticate to the RDS DB instance or Aurora DB cluster. These secrets are 3055 // stored within Amazon Secrets Manager. 3056 SecretArn *string 3057 3058 // The name of the database user to which the proxy connects. 3059 UserName *string 3060} 3061 3062// Information about valid modifications that you can make to your DB instance. 3063// Contains the result of a successful call to the 3064// DescribeValidDBInstanceModifications action. You can use this information when 3065// you call ModifyDBInstance. 3066type ValidDBInstanceModificationsMessage struct { 3067 3068 // Valid storage options for your DB instance. 3069 Storage []ValidStorageOptions 3070 3071 // Valid processor features for your DB instance. 3072 ValidProcessorFeatures []AvailableProcessorFeature 3073} 3074 3075// Information about valid modifications that you can make to your DB instance. 3076// Contains the result of a successful call to the 3077// DescribeValidDBInstanceModifications action. 3078type ValidStorageOptions struct { 3079 3080 // The valid range of Provisioned IOPS to gibibytes of storage multiplier. For 3081 // example, 3-10, which means that provisioned IOPS can be between 3 and 10 times 3082 // storage. 3083 IopsToStorageRatio []DoubleRange 3084 3085 // The valid range of provisioned IOPS. For example, 1000-20000. 3086 ProvisionedIops []Range 3087 3088 // The valid range of storage in gibibytes. For example, 100 to 16384. 3089 StorageSize []Range 3090 3091 // The valid storage types for your DB instance. For example, gp2, io1. 3092 StorageType *string 3093 3094 // Whether or not Amazon RDS can automatically scale storage for DB instances that 3095 // use the new instance class. 3096 SupportsStorageAutoscaling bool 3097} 3098 3099// This data type is used as a response element for queries on VPC security group 3100// membership. 3101type VpcSecurityGroupMembership struct { 3102 3103 // The status of the VPC security group. 3104 Status *string 3105 3106 // The name of the VPC security group. 3107 VpcSecurityGroupId *string 3108} 3109 3110// Information about the virtual private network (VPN) between the VMware vSphere 3111// cluster and the AWS website. For more information about RDS on VMware, see the 3112// RDS on VMware User Guide. 3113// (https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html) 3114type VpnDetails struct { 3115 3116 // The IP address of network traffic from AWS to your on-premises data center. 3117 VpnGatewayIp *string 3118 3119 // The ID of the VPN. 3120 VpnId *string 3121 3122 // The name of the VPN. 3123 VpnName *string 3124 3125 // The preshared key (PSK) for the VPN. 3126 VpnPSK *string 3127 3128 // The state of the VPN. 3129 VpnState *string 3130 3131 // The IP address of network traffic from your on-premises data center. A custom AZ 3132 // receives the network traffic. 3133 VpnTunnelOriginatorIP *string 3134} 3135