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