RDS (rds)

Primary Models

Primary models are models that you can act on directly. They are the models that represent resources in the AWS service, and are acted on by the managers.

pydantic model botocraft.services.rds.DBInstance[source]

Bases: TagsDictMixin, RDSInstanceModelMixin, PrimaryBoto3Model

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

Show JSON schema
{
   "title": "DBInstance",
   "description": "Contains the details of an Amazon RDS DB instance.\n\nThis data type is used as a response element in the operations ``CreateDBInstance``, ``CreateDBInstanceReadReplica``,\n``DeleteDBInstance``, ``DescribeDBInstances``, ``ModifyDBInstance``, ``PromoteReadReplica``, ``RebootDBInstance``,\n``RestoreDBInstanceFromDBSnapshot``, ``RestoreDBInstanceFromS3``, ``RestoreDBInstanceToPointInTime``,\n``StartDBInstance``, and ``StopDBInstance``.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBInstanceIdentifier": {
         "title": "Dbinstanceidentifier",
         "type": "string"
      },
      "DBInstanceClass": {
         "title": "Dbinstanceclass",
         "type": "string"
      },
      "MultiAZ": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "title": "Multiaz"
      },
      "Engine": {
         "title": "Engine",
         "type": "string"
      },
      "EngineVersion": {
         "title": "Engineversion",
         "type": "string"
      },
      "AutoMinorVersionUpgrade": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "title": "Autominorversionupgrade"
      },
      "PubliclyAccessible": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "title": "Publiclyaccessible"
      },
      "StorageEncrypted": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "title": "Storageencrypted"
      },
      "BackupRetentionPeriod": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "title": "Backupretentionperiod"
      },
      "DbInstancePort": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbinstanceport"
      },
      "IAMDatabaseAuthenticationEnabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iamdatabaseauthenticationenabled"
      },
      "EnabledCloudwatchLogsExports": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Enabledcloudwatchlogsexports"
      },
      "TagList": {
         "items": {
            "$ref": "#/$defs/Tag"
         },
         "title": "Taglist",
         "type": "array"
      },
      "CustomerOwnedIpEnabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Customerownedipenabled"
      },
      "PerformanceInsightsEnabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Performanceinsightsenabled"
      },
      "DBSubnetGroup": {
         "anyOf": [
            {
               "$ref": "#/$defs/RDSDBSubnetGroup"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "DBInstanceStatus": {
         "default": null,
         "title": "Dbinstancestatus",
         "type": "string"
      },
      "MasterUsername": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Masterusername"
      },
      "DBName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbname"
      },
      "Endpoint": {
         "$ref": "#/$defs/RDSEndpoint",
         "default": null
      },
      "AllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Allocatedstorage"
      },
      "InstanceCreateTime": {
         "default": null,
         "format": "date-time",
         "title": "Instancecreatetime",
         "type": "string"
      },
      "PreferredBackupWindow": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Preferredbackupwindow"
      },
      "DBSecurityGroups": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DBSecurityGroupMembership"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Dbsecuritygroups"
      },
      "VpcSecurityGroups": {
         "items": {
            "$ref": "#/$defs/VpcSecurityGroupMembership"
         },
         "title": "Vpcsecuritygroups",
         "type": "array"
      },
      "DBParameterGroups": {
         "items": {
            "$ref": "#/$defs/DBParameterGroupStatus"
         },
         "title": "Dbparametergroups",
         "type": "array"
      },
      "AvailabilityZone": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Availabilityzone"
      },
      "PreferredMaintenanceWindow": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Preferredmaintenancewindow"
      },
      "UpgradeRolloutOrder": {
         "default": null,
         "enum": [
            "first",
            "second",
            "last"
         ],
         "title": "Upgraderolloutorder",
         "type": "string"
      },
      "PendingModifiedValues": {
         "$ref": "#/$defs/RDSPendingModifiedValues",
         "default": null
      },
      "LatestRestorableTime": {
         "default": null,
         "format": "date-time",
         "title": "Latestrestorabletime",
         "type": "string"
      },
      "ReadReplicaSourceDBInstanceIdentifier": {
         "default": null,
         "title": "Readreplicasourcedbinstanceidentifier",
         "type": "string"
      },
      "ReadReplicaDBInstanceIdentifiers": {
         "items": {
            "type": "string"
         },
         "title": "Readreplicadbinstanceidentifiers",
         "type": "array"
      },
      "ReadReplicaDBClusterIdentifiers": {
         "items": {
            "type": "string"
         },
         "title": "Readreplicadbclusteridentifiers",
         "type": "array"
      },
      "ReplicaMode": {
         "anyOf": [
            {
               "enum": [
                  "open-read-only",
                  "mounted"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Replicamode"
      },
      "LicenseModel": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Licensemodel"
      },
      "Iops": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iops"
      },
      "StorageThroughput": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagethroughput"
      },
      "OptionGroupMemberships": {
         "items": {
            "$ref": "#/$defs/OptionGroupMembership"
         },
         "title": "Optiongroupmemberships",
         "type": "array"
      },
      "CharacterSetName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Charactersetname"
      },
      "NcharCharacterSetName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ncharcharactersetname"
      },
      "SecondaryAvailabilityZone": {
         "default": null,
         "title": "Secondaryavailabilityzone",
         "type": "string"
      },
      "StatusInfos": {
         "items": {
            "$ref": "#/$defs/DBInstanceStatusInfo"
         },
         "title": "Statusinfos",
         "type": "array"
      },
      "StorageType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagetype"
      },
      "StorageEncryptionType": {
         "default": null,
         "enum": [
            "none",
            "sse-kms",
            "sse-rds"
         ],
         "title": "Storageencryptiontype",
         "type": "string"
      },
      "TdeCredentialArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tdecredentialarn"
      },
      "DBClusterIdentifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbclusteridentifier"
      },
      "KmsKeyId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Kmskeyid"
      },
      "DbiResourceId": {
         "default": null,
         "title": "Dbiresourceid",
         "type": "string"
      },
      "CACertificateIdentifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cacertificateidentifier"
      },
      "DomainMemberships": {
         "items": {
            "$ref": "#/$defs/DomainMembership"
         },
         "title": "Domainmemberships",
         "type": "array"
      },
      "CopyTagsToSnapshot": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Copytagstosnapshot"
      },
      "MonitoringInterval": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Monitoringinterval"
      },
      "EnhancedMonitoringResourceArn": {
         "default": null,
         "title": "Enhancedmonitoringresourcearn",
         "type": "string"
      },
      "MonitoringRoleArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Monitoringrolearn"
      },
      "PromotionTier": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Promotiontier"
      },
      "DBInstanceArn": {
         "default": null,
         "title": "Dbinstancearn",
         "type": "string"
      },
      "Timezone": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Timezone"
      },
      "DatabaseInsightsMode": {
         "anyOf": [
            {
               "enum": [
                  "standard",
                  "advanced"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Databaseinsightsmode"
      },
      "PerformanceInsightsKMSKeyId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Performanceinsightskmskeyid"
      },
      "PerformanceInsightsRetentionPeriod": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Performanceinsightsretentionperiod"
      },
      "ProcessorFeatures": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/ProcessorFeature"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Processorfeatures"
      },
      "DeletionProtection": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Deletionprotection"
      },
      "AssociatedRoles": {
         "items": {
            "$ref": "#/$defs/DBInstanceRole"
         },
         "title": "Associatedroles",
         "type": "array"
      },
      "ListenerEndpoint": {
         "$ref": "#/$defs/RDSEndpoint",
         "default": null
      },
      "MaxAllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Maxallocatedstorage"
      },
      "AutomationMode": {
         "anyOf": [
            {
               "enum": [
                  "full",
                  "all-paused"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Automationmode"
      },
      "ResumeFullAutomationModeTime": {
         "default": null,
         "format": "date-time",
         "title": "Resumefullautomationmodetime",
         "type": "string"
      },
      "NetworkType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Networktype"
      },
      "ActivityStreamStatus": {
         "default": null,
         "enum": [
            "stopped",
            "starting",
            "started",
            "stopping"
         ],
         "title": "Activitystreamstatus",
         "type": "string"
      },
      "ActivityStreamKmsKeyId": {
         "default": null,
         "title": "Activitystreamkmskeyid",
         "type": "string"
      },
      "ActivityStreamKinesisStreamName": {
         "default": null,
         "title": "Activitystreamkinesisstreamname",
         "type": "string"
      },
      "ActivityStreamMode": {
         "default": null,
         "enum": [
            "sync",
            "async"
         ],
         "title": "Activitystreammode",
         "type": "string"
      },
      "ActivityStreamEngineNativeAuditFieldsIncluded": {
         "default": null,
         "title": "Activitystreamenginenativeauditfieldsincluded",
         "type": "boolean"
      },
      "AwsBackupRecoveryPointArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Awsbackuprecoverypointarn"
      },
      "DBInstanceAutomatedBackupsReplications": {
         "items": {
            "$ref": "#/$defs/DBInstanceAutomatedBackupsReplication"
         },
         "title": "Dbinstanceautomatedbackupsreplications",
         "type": "array"
      },
      "BackupTarget": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Backuptarget"
      },
      "AutomaticRestartTime": {
         "default": null,
         "format": "date-time",
         "title": "Automaticrestarttime",
         "type": "string"
      },
      "CustomIamInstanceProfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Customiaminstanceprofile"
      },
      "ActivityStreamPolicyStatus": {
         "default": null,
         "enum": [
            "locked",
            "unlocked",
            "locking-policy",
            "unlocking-policy"
         ],
         "title": "Activitystreampolicystatus",
         "type": "string"
      },
      "CertificateDetails": {
         "$ref": "#/$defs/RDSCertificateDetails",
         "default": null
      },
      "DBSystemId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbsystemid"
      },
      "MasterUserSecret": {
         "$ref": "#/$defs/RDSMasterUserSecret",
         "default": null
      },
      "ReadReplicaSourceDBClusterIdentifier": {
         "default": null,
         "title": "Readreplicasourcedbclusteridentifier",
         "type": "string"
      },
      "PercentProgress": {
         "default": null,
         "title": "Percentprogress",
         "type": "string"
      },
      "MultiTenant": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Multitenant"
      },
      "DedicatedLogVolume": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dedicatedlogvolume"
      },
      "IsStorageConfigUpgradeAvailable": {
         "default": null,
         "title": "Isstorageconfigupgradeavailable",
         "type": "boolean"
      },
      "EngineLifecycleSupport": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Enginelifecyclesupport"
      },
      "AdditionalStorageVolumes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/AdditionalStorageVolumeOutput"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Additionalstoragevolumes"
      },
      "StorageVolumeStatus": {
         "default": null,
         "title": "Storagevolumestatus",
         "type": "string"
      }
   },
   "$defs": {
      "AdditionalStorageVolume": {
         "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "title": "Volumename",
               "type": "string"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "required": [
            "VolumeName"
         ],
         "title": "AdditionalStorageVolume",
         "type": "object"
      },
      "AdditionalStorageVolumeOutput": {
         "description": "Contains information about an additional storage volume for a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Volumename"
            },
            "StorageVolumeStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagevolumestatus"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "title": "AdditionalStorageVolumeOutput",
         "type": "object"
      },
      "DBInstanceAutomatedBackupsReplication": {
         "description": "Automated backups of a DB instance replicated to another Amazon Web Services Region.\n\nThey consist of system backups, transaction logs, and database instance properties.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceAutomatedBackupsArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceautomatedbackupsarn"
            }
         },
         "title": "DBInstanceAutomatedBackupsReplication",
         "type": "object"
      },
      "DBInstanceRole": {
         "description": "Information about an Amazon Web Services Identity and Access Management (IAM) role\nthat is associated with a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "RoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rolearn"
            },
            "FeatureName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Featurename"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBInstanceRole",
         "type": "object"
      },
      "DBInstanceStatusInfo": {
         "description": "Provides a list of status information for an instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "StatusType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Statustype"
            },
            "Normal": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Normal"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "Message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message"
            }
         },
         "title": "DBInstanceStatusInfo",
         "type": "object"
      },
      "DBParameterGroupStatus": {
         "description": "The status of the DB parameter group.\n\nThis data type is used as a response element in the following actions:\n\n* ``CreateDBInstance``\n* ``CreateDBInstanceReadReplica``\n* ``DeleteDBInstance``\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBParameterGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbparametergroupname"
            },
            "ParameterApplyStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Parameterapplystatus"
            }
         },
         "title": "DBParameterGroupStatus",
         "type": "object"
      },
      "DBSecurityGroupMembership": {
         "description": "This data type is used as a response element in the following actions:\n\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceToPointInTime``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSecurityGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsecuritygroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBSecurityGroupMembership",
         "type": "object"
      },
      "DomainMembership": {
         "description": "An Active Directory Domain membership record associated with the DB instance or\ncluster.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Domain"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "FQDN": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fqdn"
            },
            "IAMRoleName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamrolename"
            },
            "OU": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ou"
            },
            "AuthSecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authsecretarn"
            },
            "DnsIps": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dnsips"
            }
         },
         "title": "DomainMembership",
         "type": "object"
      },
      "OptionGroupMembership": {
         "description": "Provides information on the option groups the DB instance is a member of.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "OptionGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Optiongroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "OptionGroupMembership",
         "type": "object"
      },
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "ProcessorFeature": {
         "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "ProcessorFeature",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSCertificateDetails": {
         "description": "The details of the DB instance\u2019s server certificate.\n\nFor more information, see `Using SSL/TLS to encrypt a connection to a DB\ninstance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon RDS User Guide*\nand  `Using SSL/TLS to encrypt a connection to a DB\ncluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon Aurora User\nGuide*.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "CAIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Caidentifier"
            },
            "ValidTill": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Validtill"
            }
         },
         "title": "RDSCertificateDetails",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSEndpoint": {
         "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a\nresponse element in the following actions:\n\n* ``CreateDBInstance``\n* ``DescribeDBInstances``\n* ``DeleteDBInstance``\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "HostedZoneId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Hostedzoneid"
            }
         },
         "title": "RDSEndpoint",
         "type": "object"
      },
      "RDSMasterUserSecret": {
         "description": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the\nmaster user password.\n\nFor more information, see\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_\nin the *Amazon RDS User Guide*    and\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_\nin the *Amazon Aurora\nUser Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretarn"
            },
            "SecretStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretstatus"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            }
         },
         "title": "RDSMasterUserSecret",
         "type": "object"
      },
      "RDSPendingCloudwatchLogsExports": {
         "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "LogTypesToEnable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestoenable"
            },
            "LogTypesToDisable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestodisable"
            }
         },
         "title": "RDSPendingCloudwatchLogsExports",
         "type": "object"
      },
      "RDSPendingModifiedValues": {
         "description": "This data type is used as a response element in the ``ModifyDBInstance`` operation\nand contains changes that will be applied during the next maintenance window.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceClass": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceclass"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "MasterUserPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masteruserpassword"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backupretentionperiod"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multiaz"
            },
            "EngineVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engineversion"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "DBInstanceIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceidentifier"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DBSubnetGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsubnetgroupname"
            },
            "PendingCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSPendingCloudwatchLogsExports"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resumefullautomationmodetime"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "Engine": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engine"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolume"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            }
         },
         "title": "RDSPendingModifiedValues",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      },
      "Tag": {
         "description": "The metadata that you apply to a resource to help you categorize and\norganize them. Each tag consists of a key and an optional value. You define\nthem.\n\nThe following basic restrictions apply to tags:\n\n* Maximum number of tags per resource - 50\n* For each resource, each tag key must be unique, and each tag key can have\n  only one value.\n* Maximum key length - 128 Unicode characters in UTF-8\n* Maximum value length - 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n  remember that other services may have restrictions on allowed characters.\n  Generally allowed characters are: letters, numbers, and spaces representable in\n  UTF-8, and the following characters: + - = . _ : / @.\n* Tag keys and values are case-sensitive.\n* Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such\n  as a prefix for either keys or values as it is reserved for Amazon Web Services\n  use. You cannot edit or delete tag keys or values with this prefix. Tags with\n  this prefix do not count against your tags per resource limit.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Key"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "Tag",
         "type": "object"
      },
      "VpcSecurityGroupMembership": {
         "description": "Used as a response element for queries on virtual private cloud (VPC) security group\nmembership.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VpcSecurityGroupId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Vpcsecuritygroupid"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "VpcSecurityGroupMembership",
         "type": "object"
      }
   },
   "required": [
      "DBInstanceIdentifier",
      "DBInstanceClass",
      "MultiAZ",
      "Engine",
      "EngineVersion",
      "PubliclyAccessible"
   ]
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field ActivityStreamEngineNativeAuditFieldsIncluded: bool = None

Indicates whether engine-native audit fields are included in the database activity stream.

field ActivityStreamKinesisStreamName: str = None

The name of the Amazon Kinesis data stream used for the database activity stream.

field ActivityStreamKmsKeyId: str = None

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

field ActivityStreamMode: Literal['sync', 'async'] = None

The mode of the database activity stream.

Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.

field ActivityStreamPolicyStatus: Literal['locked', 'unlocked', 'locking-policy', 'unlocking-policy'] = None

The status of the policy state of the activity stream.

field ActivityStreamStatus: Literal['stopped', 'starting', 'started', 'stopping'] = None

The status of the database activity stream.

field AdditionalStorageVolumes: builtins.list[AdditionalStorageVolumeOutput] | None [Optional]

The additional storage volumes associated with the DB instance.

RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

field AllocatedStorage: int | None = None

The amount of storage in gibibytes (GiB) allocated for the DB instance.

field AssociatedRoles: builtins.list[DBInstanceRole] [Optional]

The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.

field AutoMinorVersionUpgrade: bool | None = True

Indicates whether minor version patches are applied automatically.

field AutomaticRestartTime: datetime = None

The time when a stopped DB instance is restarted automatically.

field AutomationMode: Literal['full', 'all-paused'] | None = None

The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume- full-automation-mode-minutes.

field AvailabilityZone: str | None = None

The name of the Availability Zone where the DB instance is located.

field AwsBackupRecoveryPointArn: str | None = None

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

field BackupRetentionPeriod: int | None = 1

The number of days for which automatic DB snapshots are retained.

field BackupTarget: str | None = None

The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.

field CACertificateIdentifier: str | None = None

The identifier of the CA certificate for this DB instance.

field CertificateDetails: RDSCertificateDetails = None

The details of the DB instance’s server certificate.

field CharacterSetName: str | None = None

If present, specifies the name of the character set that this instance is associated with.

field CopyTagsToSnapshot: bool | None = None

Indicates whether tags are copied from the DB instance to snapshots of the DB instance.

field CustomIamInstanceProfile: str | None = None

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

The instance profile must meet the following requirements:

field CustomerOwnedIpEnabled: bool | None = None

Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

field DBClusterIdentifier: str | None = None

If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.

field DBInstanceArn: str = None

The Amazon Resource Name (ARN) for the DB instance.

field DBInstanceAutomatedBackupsReplications: builtins.list[DBInstanceAutomatedBackupsReplication] [Optional]

The list of replicated automated backups associated with the DB instance.

field DBInstanceClass: str [Required]

The name of the compute and memory capacity class of the DB instance.

field DBInstanceIdentifier: str [Required]

The user-supplied database identifier.

This identifier is the unique key that identifies a DB instance.

field DBInstanceStatus: str = None

The current state of this database.

field DBName: str | None = None

The initial database name that you provided (if required) when you created the DB instance.

This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.

field DBParameterGroups: builtins.list[DBParameterGroupStatus] [Optional]

The list of DB parameter groups applied to this DB instance.

field DBSecurityGroups: builtins.list[DBSecurityGroupMembership] | None [Optional]

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

field DBSubnetGroup: RDSDBSubnetGroup | None = None

Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

field DBSystemId: str | None = None

The Oracle system ID (Oracle SID) for a container database (CDB).

The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.

field DatabaseInsightsMode: Literal['standard', 'advanced'] | None = None

The mode of Database Insights that is enabled for the instance.

field DbInstancePort: int | None = None

The port that the DB instance listens on.

If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

field DbiResourceId: str = None

The Amazon Web Services Region-unique, immutable identifier for the DB instance.

This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.

field DedicatedLogVolume: bool | None = None

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

field DeletionProtection: bool | None = None

Indicates whether the DB instance has deletion protection enabled.

The database can’t be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

field DomainMemberships: builtins.list[DomainMembership] [Optional]

The Active Directory Domain membership records associated with the DB instance.

field EnabledCloudwatchLogsExports: builtins.list[str] | None [Optional]

A list of log types that this DB instance is configured to export to CloudWatch Logs.

field Endpoint: RDSEndpoint = None

The connection endpoint for the DB instance.

field Engine: str [Required]

The database engine used for this DB instance.

field EngineLifecycleSupport: str | None = None

The lifecycle type for the DB instance.

field EngineVersion: str [Required]

The version of the database engine.

field EnhancedMonitoringResourceArn: str = None

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

field IAMDatabaseAuthenticationEnabled: bool | None = None

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.

field InstanceCreateTime: datetime = None

The date and time when the DB instance was created.

field Iops: int | None = None

The Provisioned IOPS (I/O operations per second) value for the DB instance.

field IsStorageConfigUpgradeAvailable: bool = None

Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance.

To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.

field KmsKeyId: str | None = None

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance.

field LatestRestorableTime: datetime = None

The latest time to which a database in this DB instance can be restored with point- in-time restore.

field LicenseModel: str | None = None

The license model information for this DB instance.

This setting doesn’t apply to Amazon Aurora or RDS Custom DB instances.

field ListenerEndpoint: RDSEndpoint = None

The listener connection endpoint for SQL Server Always On.

field MasterUserSecret: RDSMasterUserSecret = None

The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

field MasterUsername: str | None = None

The master username for the DB instance.

field MaxAllocatedStorage: int | None = None

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

field MonitoringInterval: int | None = None

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

field MonitoringRoleArn: str | None = None

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

field MultiAZ: bool | None [Required]

Indicates whether the DB instance is a Multi-AZ deployment.

This setting doesn’t apply to RDS Custom DB instances.

field MultiTenant: bool | None = None

Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

field NcharCharacterSetName: str | None = None

The name of the NCHAR character set for the Oracle DB instance.

This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

field NetworkType: str | None = None

The network type of the DB instance.

field OptionGroupMemberships: builtins.list[OptionGroupMembership] [Optional]

The list of option group memberships for this DB instance.

field PendingModifiedValues: RDSPendingModifiedValues = None

Information about pending changes to the DB instance.

This information is returned only when there are pending changes. Specific changes are identified by subelements.

field PercentProgress: str = None

The progress of the storage optimization operation as a percentage.

field PerformanceInsightsEnabled: bool | None = None

Indicates whether Performance Insights is enabled for the DB instance.

field PerformanceInsightsKMSKeyId: str | None = None

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

field PerformanceInsightsRetentionPeriod: int | None = None

The number of days to retain Performance Insights data.

field PreferredBackupWindow: str | None = None

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

field PreferredMaintenanceWindow: str | None = None

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

field ProcessorFeatures: builtins.list[ProcessorFeature] | None [Optional]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

field PromotionTier: int | None = None

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

field PubliclyAccessible: bool | None [Required]

Indicates whether the DB instance is publicly accessible.

field ReadReplicaDBClusterIdentifiers: builtins.list[str] [Optional]

The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn’t contain information about cross-Region Aurora read replicas.

field ReadReplicaDBInstanceIdentifiers: builtins.list[str] [Optional]

The identifiers of the read replicas associated with this DB instance.

field ReadReplicaSourceDBClusterIdentifier: str = None

The identifier of the source DB cluster if this DB instance is a read replica.

field ReadReplicaSourceDBInstanceIdentifier: str = None

The identifier of the source DB instance if this DB instance is a read replica.

field ReplicaMode: Literal['open-read-only', 'mounted'] | None = None

The open mode of a Db2 or an Oracle read replica.

The default is open-read-only. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.

field ResumeFullAutomationModeTime: datetime = None

The number of minutes to pause the automation.

When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

field SecondaryAvailabilityZone: str = None

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

field StatusInfos: builtins.list[DBInstanceStatusInfo] [Optional]

The status of a read replica.

If the DB instance isn’t a read replica, the value is blank.

field StorageEncrypted: bool | None = True

Indicates whether the DB instance is encrypted.

field StorageEncryptionType: Literal['none', 'sse-kms', 'sse-rds'] = None

The type of encryption used to protect data at rest in the DB instance.

Possible values:

field StorageThroughput: int | None = None

The storage throughput for the DB instance.

field StorageType: str | None = None

The storage type associated with the DB instance.

field StorageVolumeStatus: str = None

The detailed status information for storage volumes associated with the DB instance.

This information helps identify which specific volume is causing the instance to be in a storage-full state.

field Tags: builtins.list[Tag] [Optional] (alias 'TagList')

A list of tags.

field TdeCredentialArn: str | None = None

The ARN from the key store with which the instance is associated for TDE encryption.

field Timezone: str | None = None

The time zone of the DB instance.

In most cases, the Timezone element is empty. Timezone content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.

field UpgradeRolloutOrder: Literal['first', 'second', 'last'] = None

This data type represents the order in which the instances are upgraded.

field VpcSecurityGroups: builtins.list[VpcSecurityGroupMembership] [Optional]

The list of Amazon EC2 VPC security groups that the DB instance belongs to.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

manager_class

alias of DBInstanceManager

tag_class

alias of Tag

delete()

Delete the model.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

save(**kwargs)

Save the model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

property arn: str | None

Return the ARN of the model. This is the value of the DBInstanceArn attribute.

Returns:

The ARN of the model instance.

property credentials: Credentials

Return the master user secret for the RDS instance.

Raises:

ValueError – If the RDS instance does not have a master user password in Secrets Manager.

Returns:

The master user secret for the RDS instance.

property name: str | None

Return the name of the model. This is the value of the DBInstanceIdentifier attribute.

Returns:

The name of the model instance.

objects: ClassVar[classproperty]

Get the manager for this model, and set it as a class property

property pk: str | None

Return the primary key of the model. This is the value of the DBInstanceArn attribute.

Returns:

The primary key of the model instance.

property security_groups: list[botocraft.services.ec2.SecurityGroup] | None

Return the security groups that this DB instance is in, if any.

Note

The output of this property is cached on the model instance, so calling this multiple times will not result in multiple calls to the AWS API. If you need a fresh copy of the data, you can re-get the model instance from the manager.

property subnet_group: RDSDBSubnetGroup | None

Return the subnet group that this DB instance is in, if any.

Note

The output of this property is cached on the model instance, so calling this multiple times will not result in multiple calls to the AWS API. If you need a fresh copy of the data, you can re-get the model instance from the manager.

property tags: TagsDict

Get the tags for the model instance.

Returns:

The tags for the model instance.

property vpc: Vpc | None

Return the VPC that this DB instance is in, if any.

Note

The output of this property is cached on the model instance, so calling this multiple times will not result in multiple calls to the AWS API. If you need a fresh copy of the data, you can re-get the model instance from the manager.

pydantic model botocraft.services.rds.RDSDBSubnetGroup[source]

Bases: PrimaryBoto3Model

Contains the details of an Amazon RDS DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

Show JSON schema
{
   "title": "RDSDBSubnetGroup",
   "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBSubnetGroupName": {
         "title": "Dbsubnetgroupname",
         "type": "string"
      },
      "DBSubnetGroupDescription": {
         "title": "Dbsubnetgroupdescription",
         "type": "string"
      },
      "Subnets": {
         "items": {
            "$ref": "#/$defs/RDSSubnet"
         },
         "title": "Subnets",
         "type": "array"
      },
      "VpcId": {
         "title": "Vpcid",
         "type": "string"
      },
      "SubnetGroupStatus": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "Complete",
         "title": "Subnetgroupstatus"
      },
      "DBSubnetGroupArn": {
         "default": null,
         "title": "Dbsubnetgrouparn",
         "type": "string"
      },
      "SupportedNetworkTypes": {
         "items": {
            "type": "string"
         },
         "title": "Supportednetworktypes",
         "type": "array"
      }
   },
   "$defs": {
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      }
   },
   "required": [
      "DBSubnetGroupName",
      "DBSubnetGroupDescription",
      "Subnets",
      "VpcId"
   ]
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBSubnetGroupArn: str = None

The Amazon Resource Name (ARN) for the DB subnet group.

field DBSubnetGroupDescription: str [Required]

Provides the description of the DB subnet group.

field DBSubnetGroupName: str [Required]

The name of the DB subnet group.

field SubnetGroupStatus: str | None = 'Complete'

Provides the status of the DB subnet group.

field Subnets: builtins.list[RDSSubnet] [Required]

Contains a list of Subnet elements.

The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly.

field SupportedNetworkTypes: builtins.list[str] [Optional]

The network type of the DB subnet group.

field VpcId: str [Required]

Provides the VpcId of the DB subnet group.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

manager_class

alias of RDSDBSubnetGroupManager

delete()

Delete the model.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

save(**kwargs)

Save the model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

property arn: str | None

Return the ARN of the model. This is the value of the DBSubnetGroupArn attribute.

Returns:

The ARN of the model instance.

property name: str | None

Return the name of the model. This is the value of the DBSubnetGroupName attribute.

Returns:

The name of the model instance.

objects: ClassVar[classproperty]

Get the manager for this model, and set it as a class property

property pk: str | None

Return the primary key of the model. This is the value of the DBSubnetGroupArn attribute.

Returns:

The primary key of the model instance.

Managers

Managers work with the primary models to provide a high-level interface to the AWS service. They are responsible for creating, updating, and deleting the resources in the service, as well as any additional operations that are available for those models.

class botocraft.services.rds.DBInstanceManager[source]

Bases: Boto3ModelManager

create(model: DBInstance, MasterUserPassword: str | None = None, VpcSecurityGroupIds: list[str] | None = None, DBSubnetGroupName: str | None = None, DBParameterGroupName: str | None = None, OptionGroupName: str | None = None, TdeCredentialPassword: str | None = None, Domain: str | None = None, DomainFqdn: str | None = None, DomainOu: str | None = None, DomainAuthSecretArn: str | None = None, DomainDnsIps: list[str] | None = None, DomainIAMRoleName: str | None = None, ManageMasterUserPassword: bool | None = None, MasterUserSecretKmsKeyId: str | None = None, TagSpecifications: list[botocraft.services.rds.RDSTagSpecification] | None = None, MasterUserAuthenticationType: Literal['password', 'iam-db-auth'] | None = None) DBInstance[source]

Creates a new DB instance.

Parameters:

model – The DBInstance to create.

Keyword Arguments:
  • MasterUserPassword – The password for the master user.

  • VpcSecurityGroupIds – A list of Amazon EC2 VPC security groups to associate with this DB instance.

  • DBSubnetGroupName – A DB subnet group to associate with this DB instance.

  • DBParameterGroupName – The name of the DB parameter group to associate with this DB instance. If you don’t specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version.

  • OptionGroupName – The option group to associate the DB instance with.

  • TdeCredentialPassword – The password for the given ARN from the key store in order to access the device.

  • Domain – The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

  • DomainFqdn – The fully qualified domain name (FQDN) of an Active Directory domain.

  • DomainOu – The Active Directory organizational unit for your DB instance to join.

  • DomainAuthSecretArn – The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

  • DomainDnsIps – The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

  • DomainIAMRoleName – The name of the IAM role to use when making API calls to the Directory Service.

  • ManageMasterUserPassword – Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

  • MasterUserSecretKmsKeyId – The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

  • TagSpecifications – Tags to assign to resources associated with the DB instance.

  • MasterUserAuthenticationType – Specifies the authentication type for the master user. With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.

delete(DBInstanceIdentifier: str, *, SkipFinalSnapshot: bool | None = None, FinalDBSnapshotIdentifier: str | None = None, DeleteAutomatedBackups: bool | None = None) DBInstance[source]

Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can’t be recovered. However, manual DB snapshots of the DB instance aren’t deleted.

Parameters:

DBInstanceIdentifier – The DB instance identifier for the DB instance to be deleted. This parameter isn’t case- sensitive.

Keyword Arguments:
  • SkipFinalSnapshot – Specifies whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn’t create a DB snapshot. If you don’t enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn’t enabled, and the DB snapshot is created.

  • FinalDBSnapshotIdentifier – The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

  • DeleteAutomatedBackups – Specifies whether to remove automated backups immediately after the DB instance is deleted. This parameter isn’t case- sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

get(DBInstanceIdentifier: str, *, Filters: list[botocraft.services.common.Filter] | None = None) DBInstance | None[source]

Describes provisioned RDS instances. This API supports pagination.

Parameters:

DBInstanceIdentifier – The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn’t case- sensitive.

Keyword Arguments:

Filters – A filter that specifies one or more DB instances to describe.

list(*, DBInstanceIdentifier: str | None = None, Filters: list[botocraft.services.common.Filter] | None = None) PrimaryBoto3ModelQuerySet[source]

Describes provisioned RDS instances. This API supports pagination.

Keyword Arguments:
  • DBInstanceIdentifier – The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn’t case- sensitive.

  • Filters – A filter that specifies one or more DB instances to describe.

update(model: DBInstance, DBSubnetGroupName: str | None = None, VpcSecurityGroupIds: list[str] | None = None, ApplyImmediately: bool | None = None, MasterUserPassword: str | None = None, DBParameterGroupName: str | None = None, AllowMajorVersionUpgrade: bool | None = None, OptionGroupName: str | None = None, NewDBInstanceIdentifier: str | None = None, TdeCredentialPassword: str | None = None, Domain: str | None = None, DomainFqdn: str | None = None, DomainOu: str | None = None, DomainAuthSecretArn: str | None = None, DomainDnsIps: list[str] | None = None, DisableDomain: bool | None = None, DBPortNumber: int | None = None, DomainIAMRoleName: str | None = None, CloudwatchLogsExportConfiguration: CloudwatchLogsExportConfiguration | None = None, UseDefaultProcessorFeatures: bool | None = None, CertificateRotationRestart: bool | None = None, ResumeFullAutomationModeMinutes: int | None = None, ManageMasterUserPassword: bool | None = None, RotateMasterUserPassword: bool | None = None, MasterUserSecretKmsKeyId: str | None = None, TagSpecifications: list[botocraft.services.rds.RDSTagSpecification] | None = None, MasterUserAuthenticationType: Literal['password', 'iam-db-auth'] | None = None) DBInstance[source]

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

Parameters:

model – The DBInstance to update.

Keyword Arguments:
  • DBSubnetGroupName – The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn’t in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

  • VpcSecurityGroupIds – A list of Amazon EC2 VPC security groups to associate with this DB instance. This change is asynchronously applied as soon as possible.

  • ApplyImmediately – Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

  • MasterUserPassword – The new password for the master user.

  • DBParameterGroupName – The name of the DB parameter group to apply to the DB instance.

  • AllowMajorVersionUpgrade – Specifies whether major version upgrades are allowed. Changing this parameter doesn’t result in an outage and the change is asynchronously applied as soon as possible.

  • OptionGroupName – The option group to associate the DB instance with.

  • NewDBInstanceIdentifier – The new identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable ApplyImmediately. This value is stored as a lowercase string.

  • TdeCredentialPassword – The password for the given ARN from the key store in order to access the device.

  • Domain – The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

  • DomainFqdn – The fully qualified domain name (FQDN) of an Active Directory domain.

  • DomainOu – The Active Directory organizational unit for your DB instance to join.

  • DomainAuthSecretArn – The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

  • DomainDnsIps – The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

  • DisableDomain – Specifies whether to remove the DB instance from the Active Directory domain.

  • DBPortNumber – The port number on which the database accepts connections.

  • DomainIAMRoleName – The name of the IAM role to use when making API calls to the Directory Service.

  • CloudwatchLogsExportConfiguration – The log types to be enabled for export to CloudWatch Logs for a specific DB instance.

  • UseDefaultProcessorFeatures – Specifies whether the DB instance class of the DB instance uses its default processor features.

  • CertificateRotationRestart – Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

  • ResumeFullAutomationModeMinutes – The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation.

  • ManageMasterUserPassword – Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

  • RotateMasterUserPassword – Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

  • MasterUserSecretKmsKeyId – The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

  • TagSpecifications – Tags to assign to resources associated with the DB instance.

  • MasterUserAuthenticationType – Specifies the authentication type for the master user. With IAM master user authentication, you can change the master DB user to use IAM database authentication.

service_name: str = 'rds'

ec2, s3, etc.

Type:

The name of the boto3 service. Example

class botocraft.services.rds.RDSDBSubnetGroupManager[source]

Bases: Boto3ModelManager

create(model: RDSDBSubnetGroup, SubnetIds: list[str]) RDSDBSubnetGroup[source]

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Parameters:
  • model – The DBSubnetGroup to create.

  • SubnetIds – The EC2 Subnet IDs for the DB subnet group.

delete(DBSubnetGroupName: str) None[source]

Deletes a DB subnet group.

Parameters:

DBSubnetGroupName – The name of the database subnet group to delete.

get(DBSubnetGroupName: str) RDSDBSubnetGroup | None[source]

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Parameters:

DBSubnetGroupName – The name of the DB subnet group to return details for.

list(*, DBSubnetGroupName: str | None = None, Filters: list[botocraft.services.common.Filter] | None = None) PrimaryBoto3ModelQuerySet[source]

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Keyword Arguments:
  • DBSubnetGroupName – The name of the DB subnet group to return details for.

  • Filters – This parameter isn’t currently supported.

update(model: RDSDBSubnetGroup, SubnetIds: list[str]) RDSDBSubnetGroup[source]

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.

Parameters:
  • model – The DBSubnetGroup to update.

  • SubnetIds – The EC2 subnet IDs for the DB subnet group.

service_name: str = 'rds'

ec2, s3, etc.

Type:

The name of the boto3 service. Example

Secondary Models

Secondary models are models that are used by the primary models to organize their data. They are not acted on directly, but are used to describe the structure of the fields in the primary models or other secondary models.

pydantic model botocraft.services.rds.AdditionalStorageVolume[source]

Bases: Boto3Model

Contains details about an additional storage volume for a DB instance.

RDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.

Show JSON schema
{
   "title": "AdditionalStorageVolume",
   "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "VolumeName": {
         "title": "Volumename",
         "type": "string"
      },
      "AllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Allocatedstorage"
      },
      "IOPS": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iops"
      },
      "MaxAllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Maxallocatedstorage"
      },
      "StorageThroughput": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagethroughput"
      },
      "StorageType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagetype"
      }
   },
   "required": [
      "VolumeName"
   ]
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field AllocatedStorage: int | None = None

The amount of storage allocated for the additional storage volume, in gibibytes (GiB).

The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

field IOPS: int | None = None

The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

field MaxAllocatedStorage: int | None = None

The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

field StorageThroughput: int | None = None

The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

This setting applies only to the General Purpose SSD (gp3) storage type.

field StorageType: str | None = None

The storage type for the additional storage volume.

field VolumeName: str [Required]

The name of the additional storage volume.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.AdditionalStorageVolumeOutput[source]

Bases: Boto3Model

Contains information about an additional storage volume for a DB instance.

Show JSON schema
{
   "title": "AdditionalStorageVolumeOutput",
   "description": "Contains information about an additional storage volume for a DB instance.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "VolumeName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Volumename"
      },
      "StorageVolumeStatus": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagevolumestatus"
      },
      "AllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Allocatedstorage"
      },
      "IOPS": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iops"
      },
      "MaxAllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Maxallocatedstorage"
      },
      "StorageThroughput": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagethroughput"
      },
      "StorageType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagetype"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field AllocatedStorage: int | None = None

The amount of storage allocated for the additional storage volume, in gibibytes (GiB).

The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

field IOPS: int | None = None

The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

field MaxAllocatedStorage: int | None = None

The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

field StorageThroughput: int | None = None

The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

field StorageType: str | None = None

The storage type for the additional storage volume.

field StorageVolumeStatus: str | None = None

The status of the additional storage volume.

field VolumeName: str | None = None

The name of the additional storage volume.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DBInstanceAutomatedBackupsReplication[source]

Bases: Boto3Model

Automated backups of a DB instance replicated to another Amazon Web Services Region.

They consist of system backups, transaction logs, and database instance properties.

Show JSON schema
{
   "title": "DBInstanceAutomatedBackupsReplication",
   "description": "Automated backups of a DB instance replicated to another Amazon Web Services Region.\n\nThey consist of system backups, transaction logs, and database instance properties.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBInstanceAutomatedBackupsArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbinstanceautomatedbackupsarn"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBInstanceAutomatedBackupsArn: str | None = None

The Amazon Resource Name (ARN) of the replicated automated backups.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DBInstanceRole[source]

Bases: Boto3Model

Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.

Show JSON schema
{
   "title": "DBInstanceRole",
   "description": "Information about an Amazon Web Services Identity and Access Management (IAM) role\nthat is associated with a DB instance.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "RoleArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Rolearn"
      },
      "FeatureName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Featurename"
      },
      "Status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Status"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field FeatureName: str | None = None

The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.

For information about supported feature names, see DBEngineVersion.

field RoleArn: str | None = None

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

field Status: str | None = None

Information about the state of association between the IAM role and the DB instance.

The Status property returns one of the following values:

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DBParameterGroupStatus[source]

Bases: Boto3Model

The status of the DB parameter group.

This data type is used as a response element in the following actions:

  • CreateDBInstance

  • CreateDBInstanceReadReplica

  • DeleteDBInstance

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

Show JSON schema
{
   "title": "DBParameterGroupStatus",
   "description": "The status of the DB parameter group.\n\nThis data type is used as a response element in the following actions:\n\n* ``CreateDBInstance``\n* ``CreateDBInstanceReadReplica``\n* ``DeleteDBInstance``\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBParameterGroupName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbparametergroupname"
      },
      "ParameterApplyStatus": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Parameterapplystatus"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBParameterGroupName: str | None = None

The name of the DB parameter group.

field ParameterApplyStatus: str | None = None

The status of parameter updates.

Valid values are:

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DBSecurityGroupMembership[source]

Bases: Boto3Model

This data type is used as a response element in the following actions:

  • ModifyDBInstance

  • RebootDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceToPointInTime

Show JSON schema
{
   "title": "DBSecurityGroupMembership",
   "description": "This data type is used as a response element in the following actions:\n\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceToPointInTime``",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBSecurityGroupName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbsecuritygroupname"
      },
      "Status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Status"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBSecurityGroupName: str | None = None

The name of the DB security group.

field Status: str | None = None

The status of the DB security group.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DomainMembership[source]

Bases: Boto3Model

An Active Directory Domain membership record associated with the DB instance or cluster.

Show JSON schema
{
   "title": "DomainMembership",
   "description": "An Active Directory Domain membership record associated with the DB instance or\ncluster.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Domain": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Domain"
      },
      "Status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Status"
      },
      "FQDN": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Fqdn"
      },
      "IAMRoleName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iamrolename"
      },
      "OU": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Ou"
      },
      "AuthSecretArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Authsecretarn"
      },
      "DnsIps": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Dnsips"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field AuthSecretArn: str | None = None

The ARN for the Secrets Manager secret with the credentials for the user that’s a member of the domain.

field DnsIps: builtins.list[str] | None [Optional]

The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.

field Domain: str | None = None

The identifier of the Active Directory Domain.

field FQDN: str | None = None

The fully qualified domain name (FQDN) of the Active Directory Domain.

field IAMRoleName: str | None = None

The name of the IAM role used when making API calls to the Directory Service.

field OU: str | None = None

The Active Directory organizational unit for the DB instance or cluster.

field Status: str | None = None

The status of the Active Directory Domain membership for the DB instance or cluster.

Values include joined, pending-join, failed, and so on.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.OptionGroupMembership[source]

Bases: Boto3Model

Provides information on the option groups the DB instance is a member of.

Show JSON schema
{
   "title": "OptionGroupMembership",
   "description": "Provides information on the option groups the DB instance is a member of.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "OptionGroupName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Optiongroupname"
      },
      "Status": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Status"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field OptionGroupName: str | None = None

The name of the option group that the instance belongs to.

field Status: str | None = None

The status of the DB instance’s option group membership.

Valid values are: in-sync, pending-apply, pending- removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.Outpost[source]

Bases: Boto3Model

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

Show JSON schema
{
   "title": "Outpost",
   "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Arn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Arn"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field Arn: str | None = None

The Amazon Resource Name (ARN) of the Outpost.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.ProcessorFeature[source]

Bases: Boto3Model

Contains the processor features of a DB instance class.

To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

  • CreateDBInstance

  • ModifyDBInstance

  • RestoreDBInstanceFromDBSnapshot

  • RestoreDBInstanceFromS3

  • RestoreDBInstanceToPointInTime

You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

In addition, you can use the following actions for DB instance class processor information:

  • DescribeDBInstances

  • DescribeDBSnapshots

  • DescribeValidDBInstanceModifications

If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:

  • You are accessing an Oracle or SQL Server DB instance.

  • Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.

  • The current number CPU cores and threads is set to a non-default value.

For more information, see Configuring the processor for a DB instance class in RDS for Oracle, Optimizing your RDS for SQL Server CPU, and DB instance classes in the Amazon RDS User Guide.

Show JSON schema
{
   "title": "ProcessorFeature",
   "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      },
      "Value": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Value"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field Name: str | None = None

The name of the processor feature.

Valid names are coreCount and threadsPerCore.

field Value: str | None = None

The value of a processor feature.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSAvailabilityZone[source]

Bases: Boto3Model

Contains Availability Zone information.

This data type is used as an element in the OrderableDBInstanceOption data type.

Show JSON schema
{
   "title": "RDSAvailabilityZone",
   "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Name": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Name"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field Name: str | None = None

The name of the Availability Zone.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSCertificateDetails[source]

Bases: Boto3Model

The details of the DB instance’s server certificate.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

Show JSON schema
{
   "title": "RDSCertificateDetails",
   "description": "The details of the DB instance\u2019s server certificate.\n\nFor more information, see `Using SSL/TLS to encrypt a connection to a DB\ninstance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon RDS User Guide*\nand  `Using SSL/TLS to encrypt a connection to a DB\ncluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon Aurora User\nGuide*.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "CAIdentifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Caidentifier"
      },
      "ValidTill": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Validtill"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field CAIdentifier: str | None = None

The CA identifier of the CA certificate used for the DB instance’s server certificate.

field ValidTill: datetime | None = None

The expiration date of the DB instance’s server certificate.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSEndpoint[source]

Bases: Boto3Model

This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

  • CreateDBInstance

  • DescribeDBInstances

  • DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

Show JSON schema
{
   "title": "RDSEndpoint",
   "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a\nresponse element in the following actions:\n\n* ``CreateDBInstance``\n* ``DescribeDBInstances``\n* ``DeleteDBInstance``\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Address": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Address"
      },
      "Port": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Port"
      },
      "HostedZoneId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Hostedzoneid"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field Address: str | None = None

Specifies the DNS address of the DB instance.

field HostedZoneId: str | None = None

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

field Port: int | None = None

Specifies the port that the database engine is listening on.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSMasterUserSecret[source]

Bases: Boto3Model

Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.

Show JSON schema
{
   "title": "RDSMasterUserSecret",
   "description": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the\nmaster user password.\n\nFor more information, see\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_\nin the *Amazon RDS User Guide*    and\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_\nin the *Amazon Aurora\nUser Guide.*",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "SecretArn": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Secretarn"
      },
      "SecretStatus": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Secretstatus"
      },
      "KmsKeyId": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Kmskeyid"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field KmsKeyId: str | None = None

The Amazon Web Services KMS key identifier that is used to encrypt the secret.

field SecretArn: str | None = None

The Amazon Resource Name (ARN) of the secret.

field SecretStatus: str | None = None

The status of the secret.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSPendingCloudwatchLogsExports[source]

Bases: Boto3Model

A list of the log types whose configuration is still pending.

In other words, these log types are in the process of being activated or deactivated.

Show JSON schema
{
   "title": "RDSPendingCloudwatchLogsExports",
   "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "LogTypesToEnable": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Logtypestoenable"
      },
      "LogTypesToDisable": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Logtypestodisable"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field LogTypesToDisable: builtins.list[str] | None [Optional]

Log types that are in the process of being enabled.

After they are enabled, these log types are exported to CloudWatch Logs.

field LogTypesToEnable: builtins.list[str] | None [Optional]

Log types that are in the process of being deactivated.

After they are deactivated, these log types aren’t exported to CloudWatch Logs.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSPendingModifiedValues[source]

Bases: Boto3Model

This data type is used as a response element in the ModifyDBInstance operation and contains changes that will be applied during the next maintenance window.

Show JSON schema
{
   "title": "RDSPendingModifiedValues",
   "description": "This data type is used as a response element in the ``ModifyDBInstance`` operation\nand contains changes that will be applied during the next maintenance window.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBInstanceClass": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbinstanceclass"
      },
      "AllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Allocatedstorage"
      },
      "MasterUserPassword": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Masteruserpassword"
      },
      "Port": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Port"
      },
      "BackupRetentionPeriod": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Backupretentionperiod"
      },
      "MultiAZ": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Multiaz"
      },
      "EngineVersion": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Engineversion"
      },
      "LicenseModel": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Licensemodel"
      },
      "Iops": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iops"
      },
      "StorageThroughput": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagethroughput"
      },
      "DBInstanceIdentifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbinstanceidentifier"
      },
      "StorageType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagetype"
      },
      "CACertificateIdentifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Cacertificateidentifier"
      },
      "DBSubnetGroupName": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dbsubnetgroupname"
      },
      "PendingCloudwatchLogsExports": {
         "anyOf": [
            {
               "$ref": "#/$defs/RDSPendingCloudwatchLogsExports"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "ProcessorFeatures": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/ProcessorFeature"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Processorfeatures"
      },
      "AutomationMode": {
         "anyOf": [
            {
               "enum": [
                  "full",
                  "all-paused"
               ],
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Automationmode"
      },
      "ResumeFullAutomationModeTime": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Resumefullautomationmodetime"
      },
      "MultiTenant": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Multitenant"
      },
      "IAMDatabaseAuthenticationEnabled": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iamdatabaseauthenticationenabled"
      },
      "DedicatedLogVolume": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Dedicatedlogvolume"
      },
      "Engine": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Engine"
      },
      "AdditionalStorageVolumes": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/AdditionalStorageVolume"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Additionalstoragevolumes"
      }
   },
   "$defs": {
      "AdditionalStorageVolume": {
         "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "title": "Volumename",
               "type": "string"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "required": [
            "VolumeName"
         ],
         "title": "AdditionalStorageVolume",
         "type": "object"
      },
      "ProcessorFeature": {
         "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "ProcessorFeature",
         "type": "object"
      },
      "RDSPendingCloudwatchLogsExports": {
         "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "LogTypesToEnable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestoenable"
            },
            "LogTypesToDisable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestodisable"
            }
         },
         "title": "RDSPendingCloudwatchLogsExports",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field AdditionalStorageVolumes: builtins.list[AdditionalStorageVolume] | None [Optional]

The additional storage volume modifications that are pending for the DB instance.

field AllocatedStorage: int | None = None

The allocated storage size for the DB instance specified in gibibytes (GiB).

field AutomationMode: Literal['full', 'all-paused'] | None = None

The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume- full-automation-mode-minutes.

field BackupRetentionPeriod: int | None = None

The number of days for which automated backups are retained.

field CACertificateIdentifier: str | None = None

The identifier of the CA certificate for the DB instance.

field DBInstanceClass: str | None = None

The name of the compute and memory capacity class for the DB instance.

field DBInstanceIdentifier: str | None = None

The database identifier for the DB instance.

field DBSubnetGroupName: str | None = None

The DB subnet group for the DB instance.

field DedicatedLogVolume: bool | None = None

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>

field Engine: str | None = None

The database engine of the DB instance.

field EngineVersion: str | None = None

The database engine version.

field IAMDatabaseAuthenticationEnabled: bool | None = None

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

field Iops: int | None = None

The Provisioned IOPS value for the DB instance.

field LicenseModel: str | None = None

The license model for the DB instance.

field MasterUserPassword: str | None = None

The master credentials for the DB instance.

field MultiAZ: bool | None = None

Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment.

field MultiTenant: bool | None = None

Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

field PendingCloudwatchLogsExports: RDSPendingCloudwatchLogsExports | None = None

A list of the log types whose configuration is still pending.

In other words, these log types are in the process of being activated or deactivated.

field Port: int | None = None

The port for the DB instance.

field ProcessorFeatures: builtins.list[ProcessorFeature] | None [Optional]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

field ResumeFullAutomationModeTime: datetime | None = None

The number of minutes to pause the automation.

When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

field StorageThroughput: int | None = None

The storage throughput of the DB instance.

field StorageType: str | None = None

The storage type of the DB instance.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSSubnet[source]

Bases: Boto3Model

This data type is used as a response element for the DescribeDBSubnetGroups operation.

Show JSON schema
{
   "title": "RDSSubnet",
   "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "SubnetIdentifier": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Subnetidentifier"
      },
      "SubnetAvailabilityZone": {
         "anyOf": [
            {
               "$ref": "#/$defs/RDSAvailabilityZone"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "SubnetOutpost": {
         "anyOf": [
            {
               "$ref": "#/$defs/Outpost"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "SubnetStatus": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Subnetstatus"
      }
   },
   "$defs": {
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field SubnetAvailabilityZone: RDSAvailabilityZone | None = None

Contains Availability Zone information.

field SubnetIdentifier: str | None = None

The identifier of the subnet.

field SubnetOutpost: Outpost | None = None

If the subnet is associated with an Outpost, this value specifies the Outpost.

field SubnetStatus: str | None = None

The status of the subnet.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

Request/Response Models

Request/response models are models that are used to describe the structure of the data that is sent to and received from the AWS service. They are used by the managers to send requests to the service and to parse the responses that are received.

You will not often use them directly – typically they are used by the managers internally to send requests and parse responses – but they are included here for completeness, and because occasionally we return them directly to you because they have some useful additional information.

pydantic model botocraft.services.rds.CreateDBInstanceResult[source]

Bases: Boto3Model

Show JSON schema
{
   "title": "CreateDBInstanceResult",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBInstance": {
         "$ref": "#/$defs/DBInstance",
         "default": null
      }
   },
   "$defs": {
      "AdditionalStorageVolume": {
         "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "title": "Volumename",
               "type": "string"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "required": [
            "VolumeName"
         ],
         "title": "AdditionalStorageVolume",
         "type": "object"
      },
      "AdditionalStorageVolumeOutput": {
         "description": "Contains information about an additional storage volume for a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Volumename"
            },
            "StorageVolumeStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagevolumestatus"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "title": "AdditionalStorageVolumeOutput",
         "type": "object"
      },
      "DBInstance": {
         "description": "Contains the details of an Amazon RDS DB instance.\n\nThis data type is used as a response element in the operations ``CreateDBInstance``, ``CreateDBInstanceReadReplica``,\n``DeleteDBInstance``, ``DescribeDBInstances``, ``ModifyDBInstance``, ``PromoteReadReplica``, ``RebootDBInstance``,\n``RestoreDBInstanceFromDBSnapshot``, ``RestoreDBInstanceFromS3``, ``RestoreDBInstanceToPointInTime``,\n``StartDBInstance``, and ``StopDBInstance``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceIdentifier": {
               "title": "Dbinstanceidentifier",
               "type": "string"
            },
            "DBInstanceClass": {
               "title": "Dbinstanceclass",
               "type": "string"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Multiaz"
            },
            "Engine": {
               "title": "Engine",
               "type": "string"
            },
            "EngineVersion": {
               "title": "Engineversion",
               "type": "string"
            },
            "AutoMinorVersionUpgrade": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Autominorversionupgrade"
            },
            "PubliclyAccessible": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Publiclyaccessible"
            },
            "StorageEncrypted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Storageencrypted"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "title": "Backupretentionperiod"
            },
            "DbInstancePort": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceport"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "EnabledCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Enabledcloudwatchlogsexports"
            },
            "TagList": {
               "items": {
                  "$ref": "#/$defs/Tag"
               },
               "title": "Taglist",
               "type": "array"
            },
            "CustomerOwnedIpEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customerownedipenabled"
            },
            "PerformanceInsightsEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsenabled"
            },
            "DBSubnetGroup": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSDBSubnetGroup"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "DBInstanceStatus": {
               "default": null,
               "title": "Dbinstancestatus",
               "type": "string"
            },
            "MasterUsername": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masterusername"
            },
            "DBName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbname"
            },
            "Endpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "InstanceCreateTime": {
               "default": null,
               "format": "date-time",
               "title": "Instancecreatetime",
               "type": "string"
            },
            "PreferredBackupWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredbackupwindow"
            },
            "DBSecurityGroups": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/DBSecurityGroupMembership"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dbsecuritygroups"
            },
            "VpcSecurityGroups": {
               "items": {
                  "$ref": "#/$defs/VpcSecurityGroupMembership"
               },
               "title": "Vpcsecuritygroups",
               "type": "array"
            },
            "DBParameterGroups": {
               "items": {
                  "$ref": "#/$defs/DBParameterGroupStatus"
               },
               "title": "Dbparametergroups",
               "type": "array"
            },
            "AvailabilityZone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Availabilityzone"
            },
            "PreferredMaintenanceWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredmaintenancewindow"
            },
            "UpgradeRolloutOrder": {
               "default": null,
               "enum": [
                  "first",
                  "second",
                  "last"
               ],
               "title": "Upgraderolloutorder",
               "type": "string"
            },
            "PendingModifiedValues": {
               "$ref": "#/$defs/RDSPendingModifiedValues",
               "default": null
            },
            "LatestRestorableTime": {
               "default": null,
               "format": "date-time",
               "title": "Latestrestorabletime",
               "type": "string"
            },
            "ReadReplicaSourceDBInstanceIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbinstanceidentifier",
               "type": "string"
            },
            "ReadReplicaDBInstanceIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbinstanceidentifiers",
               "type": "array"
            },
            "ReadReplicaDBClusterIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbclusteridentifiers",
               "type": "array"
            },
            "ReplicaMode": {
               "anyOf": [
                  {
                     "enum": [
                        "open-read-only",
                        "mounted"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Replicamode"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "OptionGroupMemberships": {
               "items": {
                  "$ref": "#/$defs/OptionGroupMembership"
               },
               "title": "Optiongroupmemberships",
               "type": "array"
            },
            "CharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Charactersetname"
            },
            "NcharCharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ncharcharactersetname"
            },
            "SecondaryAvailabilityZone": {
               "default": null,
               "title": "Secondaryavailabilityzone",
               "type": "string"
            },
            "StatusInfos": {
               "items": {
                  "$ref": "#/$defs/DBInstanceStatusInfo"
               },
               "title": "Statusinfos",
               "type": "array"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "StorageEncryptionType": {
               "default": null,
               "enum": [
                  "none",
                  "sse-kms",
                  "sse-rds"
               ],
               "title": "Storageencryptiontype",
               "type": "string"
            },
            "TdeCredentialArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tdecredentialarn"
            },
            "DBClusterIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbclusteridentifier"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            },
            "DbiResourceId": {
               "default": null,
               "title": "Dbiresourceid",
               "type": "string"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DomainMemberships": {
               "items": {
                  "$ref": "#/$defs/DomainMembership"
               },
               "title": "Domainmemberships",
               "type": "array"
            },
            "CopyTagsToSnapshot": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Copytagstosnapshot"
            },
            "MonitoringInterval": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringinterval"
            },
            "EnhancedMonitoringResourceArn": {
               "default": null,
               "title": "Enhancedmonitoringresourcearn",
               "type": "string"
            },
            "MonitoringRoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringrolearn"
            },
            "PromotionTier": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Promotiontier"
            },
            "DBInstanceArn": {
               "default": null,
               "title": "Dbinstancearn",
               "type": "string"
            },
            "Timezone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Timezone"
            },
            "DatabaseInsightsMode": {
               "anyOf": [
                  {
                     "enum": [
                        "standard",
                        "advanced"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Databaseinsightsmode"
            },
            "PerformanceInsightsKMSKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightskmskeyid"
            },
            "PerformanceInsightsRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsretentionperiod"
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "DeletionProtection": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Deletionprotection"
            },
            "AssociatedRoles": {
               "items": {
                  "$ref": "#/$defs/DBInstanceRole"
               },
               "title": "Associatedroles",
               "type": "array"
            },
            "ListenerEndpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "default": null,
               "format": "date-time",
               "title": "Resumefullautomationmodetime",
               "type": "string"
            },
            "NetworkType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Networktype"
            },
            "ActivityStreamStatus": {
               "default": null,
               "enum": [
                  "stopped",
                  "starting",
                  "started",
                  "stopping"
               ],
               "title": "Activitystreamstatus",
               "type": "string"
            },
            "ActivityStreamKmsKeyId": {
               "default": null,
               "title": "Activitystreamkmskeyid",
               "type": "string"
            },
            "ActivityStreamKinesisStreamName": {
               "default": null,
               "title": "Activitystreamkinesisstreamname",
               "type": "string"
            },
            "ActivityStreamMode": {
               "default": null,
               "enum": [
                  "sync",
                  "async"
               ],
               "title": "Activitystreammode",
               "type": "string"
            },
            "ActivityStreamEngineNativeAuditFieldsIncluded": {
               "default": null,
               "title": "Activitystreamenginenativeauditfieldsincluded",
               "type": "boolean"
            },
            "AwsBackupRecoveryPointArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Awsbackuprecoverypointarn"
            },
            "DBInstanceAutomatedBackupsReplications": {
               "items": {
                  "$ref": "#/$defs/DBInstanceAutomatedBackupsReplication"
               },
               "title": "Dbinstanceautomatedbackupsreplications",
               "type": "array"
            },
            "BackupTarget": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backuptarget"
            },
            "AutomaticRestartTime": {
               "default": null,
               "format": "date-time",
               "title": "Automaticrestarttime",
               "type": "string"
            },
            "CustomIamInstanceProfile": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customiaminstanceprofile"
            },
            "ActivityStreamPolicyStatus": {
               "default": null,
               "enum": [
                  "locked",
                  "unlocked",
                  "locking-policy",
                  "unlocking-policy"
               ],
               "title": "Activitystreampolicystatus",
               "type": "string"
            },
            "CertificateDetails": {
               "$ref": "#/$defs/RDSCertificateDetails",
               "default": null
            },
            "DBSystemId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsystemid"
            },
            "MasterUserSecret": {
               "$ref": "#/$defs/RDSMasterUserSecret",
               "default": null
            },
            "ReadReplicaSourceDBClusterIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbclusteridentifier",
               "type": "string"
            },
            "PercentProgress": {
               "default": null,
               "title": "Percentprogress",
               "type": "string"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "IsStorageConfigUpgradeAvailable": {
               "default": null,
               "title": "Isstorageconfigupgradeavailable",
               "type": "boolean"
            },
            "EngineLifecycleSupport": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Enginelifecyclesupport"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolumeOutput"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            },
            "StorageVolumeStatus": {
               "default": null,
               "title": "Storagevolumestatus",
               "type": "string"
            }
         },
         "required": [
            "DBInstanceIdentifier",
            "DBInstanceClass",
            "MultiAZ",
            "Engine",
            "EngineVersion",
            "PubliclyAccessible"
         ],
         "title": "DBInstance",
         "type": "object"
      },
      "DBInstanceAutomatedBackupsReplication": {
         "description": "Automated backups of a DB instance replicated to another Amazon Web Services Region.\n\nThey consist of system backups, transaction logs, and database instance properties.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceAutomatedBackupsArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceautomatedbackupsarn"
            }
         },
         "title": "DBInstanceAutomatedBackupsReplication",
         "type": "object"
      },
      "DBInstanceRole": {
         "description": "Information about an Amazon Web Services Identity and Access Management (IAM) role\nthat is associated with a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "RoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rolearn"
            },
            "FeatureName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Featurename"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBInstanceRole",
         "type": "object"
      },
      "DBInstanceStatusInfo": {
         "description": "Provides a list of status information for an instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "StatusType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Statustype"
            },
            "Normal": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Normal"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "Message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message"
            }
         },
         "title": "DBInstanceStatusInfo",
         "type": "object"
      },
      "DBParameterGroupStatus": {
         "description": "The status of the DB parameter group.\n\nThis data type is used as a response element in the following actions:\n\n* ``CreateDBInstance``\n* ``CreateDBInstanceReadReplica``\n* ``DeleteDBInstance``\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBParameterGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbparametergroupname"
            },
            "ParameterApplyStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Parameterapplystatus"
            }
         },
         "title": "DBParameterGroupStatus",
         "type": "object"
      },
      "DBSecurityGroupMembership": {
         "description": "This data type is used as a response element in the following actions:\n\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceToPointInTime``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSecurityGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsecuritygroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBSecurityGroupMembership",
         "type": "object"
      },
      "DomainMembership": {
         "description": "An Active Directory Domain membership record associated with the DB instance or\ncluster.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Domain"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "FQDN": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fqdn"
            },
            "IAMRoleName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamrolename"
            },
            "OU": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ou"
            },
            "AuthSecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authsecretarn"
            },
            "DnsIps": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dnsips"
            }
         },
         "title": "DomainMembership",
         "type": "object"
      },
      "OptionGroupMembership": {
         "description": "Provides information on the option groups the DB instance is a member of.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "OptionGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Optiongroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "OptionGroupMembership",
         "type": "object"
      },
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "ProcessorFeature": {
         "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "ProcessorFeature",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSCertificateDetails": {
         "description": "The details of the DB instance\u2019s server certificate.\n\nFor more information, see `Using SSL/TLS to encrypt a connection to a DB\ninstance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon RDS User Guide*\nand  `Using SSL/TLS to encrypt a connection to a DB\ncluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon Aurora User\nGuide*.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "CAIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Caidentifier"
            },
            "ValidTill": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Validtill"
            }
         },
         "title": "RDSCertificateDetails",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSEndpoint": {
         "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a\nresponse element in the following actions:\n\n* ``CreateDBInstance``\n* ``DescribeDBInstances``\n* ``DeleteDBInstance``\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "HostedZoneId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Hostedzoneid"
            }
         },
         "title": "RDSEndpoint",
         "type": "object"
      },
      "RDSMasterUserSecret": {
         "description": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the\nmaster user password.\n\nFor more information, see\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_\nin the *Amazon RDS User Guide*    and\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_\nin the *Amazon Aurora\nUser Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretarn"
            },
            "SecretStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretstatus"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            }
         },
         "title": "RDSMasterUserSecret",
         "type": "object"
      },
      "RDSPendingCloudwatchLogsExports": {
         "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "LogTypesToEnable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestoenable"
            },
            "LogTypesToDisable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestodisable"
            }
         },
         "title": "RDSPendingCloudwatchLogsExports",
         "type": "object"
      },
      "RDSPendingModifiedValues": {
         "description": "This data type is used as a response element in the ``ModifyDBInstance`` operation\nand contains changes that will be applied during the next maintenance window.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceClass": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceclass"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "MasterUserPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masteruserpassword"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backupretentionperiod"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multiaz"
            },
            "EngineVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engineversion"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "DBInstanceIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceidentifier"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DBSubnetGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsubnetgroupname"
            },
            "PendingCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSPendingCloudwatchLogsExports"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resumefullautomationmodetime"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "Engine": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engine"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolume"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            }
         },
         "title": "RDSPendingModifiedValues",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      },
      "Tag": {
         "description": "The metadata that you apply to a resource to help you categorize and\norganize them. Each tag consists of a key and an optional value. You define\nthem.\n\nThe following basic restrictions apply to tags:\n\n* Maximum number of tags per resource - 50\n* For each resource, each tag key must be unique, and each tag key can have\n  only one value.\n* Maximum key length - 128 Unicode characters in UTF-8\n* Maximum value length - 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n  remember that other services may have restrictions on allowed characters.\n  Generally allowed characters are: letters, numbers, and spaces representable in\n  UTF-8, and the following characters: + - = . _ : / @.\n* Tag keys and values are case-sensitive.\n* Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such\n  as a prefix for either keys or values as it is reserved for Amazon Web Services\n  use. You cannot edit or delete tag keys or values with this prefix. Tags with\n  this prefix do not count against your tags per resource limit.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Key"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "Tag",
         "type": "object"
      },
      "VpcSecurityGroupMembership": {
         "description": "Used as a response element for queries on virtual private cloud (VPC) security group\nmembership.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VpcSecurityGroupId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Vpcsecuritygroupid"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "VpcSecurityGroupMembership",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field RDSDBInstance: DBInstance = None (alias 'DBInstance')

Contains the details of an Amazon RDS DB instance.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.CreateDBSubnetGroupResult[source]

Bases: Boto3Model

Show JSON schema
{
   "title": "CreateDBSubnetGroupResult",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBSubnetGroup": {
         "anyOf": [
            {
               "$ref": "#/$defs/RDSDBSubnetGroup"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBSubnetGroup: RDSDBSubnetGroup | None = None

Contains the details of an Amazon RDS DB subnet group.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DBInstanceMessage[source]

Bases: Boto3Model

Contains the result of a successful invocation of the DescribeDBInstances action.

Show JSON schema
{
   "title": "DBInstanceMessage",
   "description": "Contains the result of a successful invocation of the ``DescribeDBInstances``\naction.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Marker": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Marker"
      },
      "DBInstances": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/DBInstance"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Dbinstances"
      }
   },
   "$defs": {
      "AdditionalStorageVolume": {
         "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "title": "Volumename",
               "type": "string"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "required": [
            "VolumeName"
         ],
         "title": "AdditionalStorageVolume",
         "type": "object"
      },
      "AdditionalStorageVolumeOutput": {
         "description": "Contains information about an additional storage volume for a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Volumename"
            },
            "StorageVolumeStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagevolumestatus"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "title": "AdditionalStorageVolumeOutput",
         "type": "object"
      },
      "DBInstance": {
         "description": "Contains the details of an Amazon RDS DB instance.\n\nThis data type is used as a response element in the operations ``CreateDBInstance``, ``CreateDBInstanceReadReplica``,\n``DeleteDBInstance``, ``DescribeDBInstances``, ``ModifyDBInstance``, ``PromoteReadReplica``, ``RebootDBInstance``,\n``RestoreDBInstanceFromDBSnapshot``, ``RestoreDBInstanceFromS3``, ``RestoreDBInstanceToPointInTime``,\n``StartDBInstance``, and ``StopDBInstance``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceIdentifier": {
               "title": "Dbinstanceidentifier",
               "type": "string"
            },
            "DBInstanceClass": {
               "title": "Dbinstanceclass",
               "type": "string"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Multiaz"
            },
            "Engine": {
               "title": "Engine",
               "type": "string"
            },
            "EngineVersion": {
               "title": "Engineversion",
               "type": "string"
            },
            "AutoMinorVersionUpgrade": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Autominorversionupgrade"
            },
            "PubliclyAccessible": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Publiclyaccessible"
            },
            "StorageEncrypted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Storageencrypted"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "title": "Backupretentionperiod"
            },
            "DbInstancePort": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceport"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "EnabledCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Enabledcloudwatchlogsexports"
            },
            "TagList": {
               "items": {
                  "$ref": "#/$defs/Tag"
               },
               "title": "Taglist",
               "type": "array"
            },
            "CustomerOwnedIpEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customerownedipenabled"
            },
            "PerformanceInsightsEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsenabled"
            },
            "DBSubnetGroup": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSDBSubnetGroup"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "DBInstanceStatus": {
               "default": null,
               "title": "Dbinstancestatus",
               "type": "string"
            },
            "MasterUsername": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masterusername"
            },
            "DBName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbname"
            },
            "Endpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "InstanceCreateTime": {
               "default": null,
               "format": "date-time",
               "title": "Instancecreatetime",
               "type": "string"
            },
            "PreferredBackupWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredbackupwindow"
            },
            "DBSecurityGroups": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/DBSecurityGroupMembership"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dbsecuritygroups"
            },
            "VpcSecurityGroups": {
               "items": {
                  "$ref": "#/$defs/VpcSecurityGroupMembership"
               },
               "title": "Vpcsecuritygroups",
               "type": "array"
            },
            "DBParameterGroups": {
               "items": {
                  "$ref": "#/$defs/DBParameterGroupStatus"
               },
               "title": "Dbparametergroups",
               "type": "array"
            },
            "AvailabilityZone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Availabilityzone"
            },
            "PreferredMaintenanceWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredmaintenancewindow"
            },
            "UpgradeRolloutOrder": {
               "default": null,
               "enum": [
                  "first",
                  "second",
                  "last"
               ],
               "title": "Upgraderolloutorder",
               "type": "string"
            },
            "PendingModifiedValues": {
               "$ref": "#/$defs/RDSPendingModifiedValues",
               "default": null
            },
            "LatestRestorableTime": {
               "default": null,
               "format": "date-time",
               "title": "Latestrestorabletime",
               "type": "string"
            },
            "ReadReplicaSourceDBInstanceIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbinstanceidentifier",
               "type": "string"
            },
            "ReadReplicaDBInstanceIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbinstanceidentifiers",
               "type": "array"
            },
            "ReadReplicaDBClusterIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbclusteridentifiers",
               "type": "array"
            },
            "ReplicaMode": {
               "anyOf": [
                  {
                     "enum": [
                        "open-read-only",
                        "mounted"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Replicamode"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "OptionGroupMemberships": {
               "items": {
                  "$ref": "#/$defs/OptionGroupMembership"
               },
               "title": "Optiongroupmemberships",
               "type": "array"
            },
            "CharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Charactersetname"
            },
            "NcharCharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ncharcharactersetname"
            },
            "SecondaryAvailabilityZone": {
               "default": null,
               "title": "Secondaryavailabilityzone",
               "type": "string"
            },
            "StatusInfos": {
               "items": {
                  "$ref": "#/$defs/DBInstanceStatusInfo"
               },
               "title": "Statusinfos",
               "type": "array"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "StorageEncryptionType": {
               "default": null,
               "enum": [
                  "none",
                  "sse-kms",
                  "sse-rds"
               ],
               "title": "Storageencryptiontype",
               "type": "string"
            },
            "TdeCredentialArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tdecredentialarn"
            },
            "DBClusterIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbclusteridentifier"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            },
            "DbiResourceId": {
               "default": null,
               "title": "Dbiresourceid",
               "type": "string"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DomainMemberships": {
               "items": {
                  "$ref": "#/$defs/DomainMembership"
               },
               "title": "Domainmemberships",
               "type": "array"
            },
            "CopyTagsToSnapshot": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Copytagstosnapshot"
            },
            "MonitoringInterval": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringinterval"
            },
            "EnhancedMonitoringResourceArn": {
               "default": null,
               "title": "Enhancedmonitoringresourcearn",
               "type": "string"
            },
            "MonitoringRoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringrolearn"
            },
            "PromotionTier": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Promotiontier"
            },
            "DBInstanceArn": {
               "default": null,
               "title": "Dbinstancearn",
               "type": "string"
            },
            "Timezone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Timezone"
            },
            "DatabaseInsightsMode": {
               "anyOf": [
                  {
                     "enum": [
                        "standard",
                        "advanced"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Databaseinsightsmode"
            },
            "PerformanceInsightsKMSKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightskmskeyid"
            },
            "PerformanceInsightsRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsretentionperiod"
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "DeletionProtection": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Deletionprotection"
            },
            "AssociatedRoles": {
               "items": {
                  "$ref": "#/$defs/DBInstanceRole"
               },
               "title": "Associatedroles",
               "type": "array"
            },
            "ListenerEndpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "default": null,
               "format": "date-time",
               "title": "Resumefullautomationmodetime",
               "type": "string"
            },
            "NetworkType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Networktype"
            },
            "ActivityStreamStatus": {
               "default": null,
               "enum": [
                  "stopped",
                  "starting",
                  "started",
                  "stopping"
               ],
               "title": "Activitystreamstatus",
               "type": "string"
            },
            "ActivityStreamKmsKeyId": {
               "default": null,
               "title": "Activitystreamkmskeyid",
               "type": "string"
            },
            "ActivityStreamKinesisStreamName": {
               "default": null,
               "title": "Activitystreamkinesisstreamname",
               "type": "string"
            },
            "ActivityStreamMode": {
               "default": null,
               "enum": [
                  "sync",
                  "async"
               ],
               "title": "Activitystreammode",
               "type": "string"
            },
            "ActivityStreamEngineNativeAuditFieldsIncluded": {
               "default": null,
               "title": "Activitystreamenginenativeauditfieldsincluded",
               "type": "boolean"
            },
            "AwsBackupRecoveryPointArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Awsbackuprecoverypointarn"
            },
            "DBInstanceAutomatedBackupsReplications": {
               "items": {
                  "$ref": "#/$defs/DBInstanceAutomatedBackupsReplication"
               },
               "title": "Dbinstanceautomatedbackupsreplications",
               "type": "array"
            },
            "BackupTarget": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backuptarget"
            },
            "AutomaticRestartTime": {
               "default": null,
               "format": "date-time",
               "title": "Automaticrestarttime",
               "type": "string"
            },
            "CustomIamInstanceProfile": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customiaminstanceprofile"
            },
            "ActivityStreamPolicyStatus": {
               "default": null,
               "enum": [
                  "locked",
                  "unlocked",
                  "locking-policy",
                  "unlocking-policy"
               ],
               "title": "Activitystreampolicystatus",
               "type": "string"
            },
            "CertificateDetails": {
               "$ref": "#/$defs/RDSCertificateDetails",
               "default": null
            },
            "DBSystemId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsystemid"
            },
            "MasterUserSecret": {
               "$ref": "#/$defs/RDSMasterUserSecret",
               "default": null
            },
            "ReadReplicaSourceDBClusterIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbclusteridentifier",
               "type": "string"
            },
            "PercentProgress": {
               "default": null,
               "title": "Percentprogress",
               "type": "string"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "IsStorageConfigUpgradeAvailable": {
               "default": null,
               "title": "Isstorageconfigupgradeavailable",
               "type": "boolean"
            },
            "EngineLifecycleSupport": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Enginelifecyclesupport"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolumeOutput"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            },
            "StorageVolumeStatus": {
               "default": null,
               "title": "Storagevolumestatus",
               "type": "string"
            }
         },
         "required": [
            "DBInstanceIdentifier",
            "DBInstanceClass",
            "MultiAZ",
            "Engine",
            "EngineVersion",
            "PubliclyAccessible"
         ],
         "title": "DBInstance",
         "type": "object"
      },
      "DBInstanceAutomatedBackupsReplication": {
         "description": "Automated backups of a DB instance replicated to another Amazon Web Services Region.\n\nThey consist of system backups, transaction logs, and database instance properties.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceAutomatedBackupsArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceautomatedbackupsarn"
            }
         },
         "title": "DBInstanceAutomatedBackupsReplication",
         "type": "object"
      },
      "DBInstanceRole": {
         "description": "Information about an Amazon Web Services Identity and Access Management (IAM) role\nthat is associated with a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "RoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rolearn"
            },
            "FeatureName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Featurename"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBInstanceRole",
         "type": "object"
      },
      "DBInstanceStatusInfo": {
         "description": "Provides a list of status information for an instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "StatusType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Statustype"
            },
            "Normal": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Normal"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "Message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message"
            }
         },
         "title": "DBInstanceStatusInfo",
         "type": "object"
      },
      "DBParameterGroupStatus": {
         "description": "The status of the DB parameter group.\n\nThis data type is used as a response element in the following actions:\n\n* ``CreateDBInstance``\n* ``CreateDBInstanceReadReplica``\n* ``DeleteDBInstance``\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBParameterGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbparametergroupname"
            },
            "ParameterApplyStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Parameterapplystatus"
            }
         },
         "title": "DBParameterGroupStatus",
         "type": "object"
      },
      "DBSecurityGroupMembership": {
         "description": "This data type is used as a response element in the following actions:\n\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceToPointInTime``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSecurityGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsecuritygroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBSecurityGroupMembership",
         "type": "object"
      },
      "DomainMembership": {
         "description": "An Active Directory Domain membership record associated with the DB instance or\ncluster.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Domain"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "FQDN": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fqdn"
            },
            "IAMRoleName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamrolename"
            },
            "OU": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ou"
            },
            "AuthSecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authsecretarn"
            },
            "DnsIps": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dnsips"
            }
         },
         "title": "DomainMembership",
         "type": "object"
      },
      "OptionGroupMembership": {
         "description": "Provides information on the option groups the DB instance is a member of.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "OptionGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Optiongroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "OptionGroupMembership",
         "type": "object"
      },
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "ProcessorFeature": {
         "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "ProcessorFeature",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSCertificateDetails": {
         "description": "The details of the DB instance\u2019s server certificate.\n\nFor more information, see `Using SSL/TLS to encrypt a connection to a DB\ninstance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon RDS User Guide*\nand  `Using SSL/TLS to encrypt a connection to a DB\ncluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon Aurora User\nGuide*.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "CAIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Caidentifier"
            },
            "ValidTill": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Validtill"
            }
         },
         "title": "RDSCertificateDetails",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSEndpoint": {
         "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a\nresponse element in the following actions:\n\n* ``CreateDBInstance``\n* ``DescribeDBInstances``\n* ``DeleteDBInstance``\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "HostedZoneId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Hostedzoneid"
            }
         },
         "title": "RDSEndpoint",
         "type": "object"
      },
      "RDSMasterUserSecret": {
         "description": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the\nmaster user password.\n\nFor more information, see\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_\nin the *Amazon RDS User Guide*    and\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_\nin the *Amazon Aurora\nUser Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretarn"
            },
            "SecretStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretstatus"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            }
         },
         "title": "RDSMasterUserSecret",
         "type": "object"
      },
      "RDSPendingCloudwatchLogsExports": {
         "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "LogTypesToEnable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestoenable"
            },
            "LogTypesToDisable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestodisable"
            }
         },
         "title": "RDSPendingCloudwatchLogsExports",
         "type": "object"
      },
      "RDSPendingModifiedValues": {
         "description": "This data type is used as a response element in the ``ModifyDBInstance`` operation\nand contains changes that will be applied during the next maintenance window.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceClass": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceclass"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "MasterUserPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masteruserpassword"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backupretentionperiod"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multiaz"
            },
            "EngineVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engineversion"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "DBInstanceIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceidentifier"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DBSubnetGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsubnetgroupname"
            },
            "PendingCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSPendingCloudwatchLogsExports"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resumefullautomationmodetime"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "Engine": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engine"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolume"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            }
         },
         "title": "RDSPendingModifiedValues",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      },
      "Tag": {
         "description": "The metadata that you apply to a resource to help you categorize and\norganize them. Each tag consists of a key and an optional value. You define\nthem.\n\nThe following basic restrictions apply to tags:\n\n* Maximum number of tags per resource - 50\n* For each resource, each tag key must be unique, and each tag key can have\n  only one value.\n* Maximum key length - 128 Unicode characters in UTF-8\n* Maximum value length - 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n  remember that other services may have restrictions on allowed characters.\n  Generally allowed characters are: letters, numbers, and spaces representable in\n  UTF-8, and the following characters: + - = . _ : / @.\n* Tag keys and values are case-sensitive.\n* Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such\n  as a prefix for either keys or values as it is reserved for Amazon Web Services\n  use. You cannot edit or delete tag keys or values with this prefix. Tags with\n  this prefix do not count against your tags per resource limit.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Key"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "Tag",
         "type": "object"
      },
      "VpcSecurityGroupMembership": {
         "description": "Used as a response element for queries on virtual private cloud (VPC) security group\nmembership.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VpcSecurityGroupId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Vpcsecuritygroupid"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "VpcSecurityGroupMembership",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBInstances: builtins.list[DBInstance] | None [Optional]

A list of DBInstance instances.

field Marker: str | None = None

An optional pagination token provided by a previous request.

If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DBSubnetGroupMessage[source]

Bases: Boto3Model

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

Show JSON schema
{
   "title": "DBSubnetGroupMessage",
   "description": "Contains the result of a successful invocation of the ``DescribeDBSubnetGroups``\naction.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "Marker": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Marker"
      },
      "DBSubnetGroups": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/RDSDBSubnetGroup"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Dbsubnetgroups"
      }
   },
   "$defs": {
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBSubnetGroups: builtins.list[RDSDBSubnetGroup] | None [Optional]

A list of DBSubnetGroup instances.

field Marker: str | None = None

An optional pagination token provided by a previous request.

If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.DeleteDBInstanceResult[source]

Bases: Boto3Model

Show JSON schema
{
   "title": "DeleteDBInstanceResult",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBInstance": {
         "$ref": "#/$defs/DBInstance",
         "default": null
      }
   },
   "$defs": {
      "AdditionalStorageVolume": {
         "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "title": "Volumename",
               "type": "string"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "required": [
            "VolumeName"
         ],
         "title": "AdditionalStorageVolume",
         "type": "object"
      },
      "AdditionalStorageVolumeOutput": {
         "description": "Contains information about an additional storage volume for a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Volumename"
            },
            "StorageVolumeStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagevolumestatus"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "title": "AdditionalStorageVolumeOutput",
         "type": "object"
      },
      "DBInstance": {
         "description": "Contains the details of an Amazon RDS DB instance.\n\nThis data type is used as a response element in the operations ``CreateDBInstance``, ``CreateDBInstanceReadReplica``,\n``DeleteDBInstance``, ``DescribeDBInstances``, ``ModifyDBInstance``, ``PromoteReadReplica``, ``RebootDBInstance``,\n``RestoreDBInstanceFromDBSnapshot``, ``RestoreDBInstanceFromS3``, ``RestoreDBInstanceToPointInTime``,\n``StartDBInstance``, and ``StopDBInstance``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceIdentifier": {
               "title": "Dbinstanceidentifier",
               "type": "string"
            },
            "DBInstanceClass": {
               "title": "Dbinstanceclass",
               "type": "string"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Multiaz"
            },
            "Engine": {
               "title": "Engine",
               "type": "string"
            },
            "EngineVersion": {
               "title": "Engineversion",
               "type": "string"
            },
            "AutoMinorVersionUpgrade": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Autominorversionupgrade"
            },
            "PubliclyAccessible": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Publiclyaccessible"
            },
            "StorageEncrypted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Storageencrypted"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "title": "Backupretentionperiod"
            },
            "DbInstancePort": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceport"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "EnabledCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Enabledcloudwatchlogsexports"
            },
            "TagList": {
               "items": {
                  "$ref": "#/$defs/Tag"
               },
               "title": "Taglist",
               "type": "array"
            },
            "CustomerOwnedIpEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customerownedipenabled"
            },
            "PerformanceInsightsEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsenabled"
            },
            "DBSubnetGroup": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSDBSubnetGroup"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "DBInstanceStatus": {
               "default": null,
               "title": "Dbinstancestatus",
               "type": "string"
            },
            "MasterUsername": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masterusername"
            },
            "DBName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbname"
            },
            "Endpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "InstanceCreateTime": {
               "default": null,
               "format": "date-time",
               "title": "Instancecreatetime",
               "type": "string"
            },
            "PreferredBackupWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredbackupwindow"
            },
            "DBSecurityGroups": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/DBSecurityGroupMembership"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dbsecuritygroups"
            },
            "VpcSecurityGroups": {
               "items": {
                  "$ref": "#/$defs/VpcSecurityGroupMembership"
               },
               "title": "Vpcsecuritygroups",
               "type": "array"
            },
            "DBParameterGroups": {
               "items": {
                  "$ref": "#/$defs/DBParameterGroupStatus"
               },
               "title": "Dbparametergroups",
               "type": "array"
            },
            "AvailabilityZone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Availabilityzone"
            },
            "PreferredMaintenanceWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredmaintenancewindow"
            },
            "UpgradeRolloutOrder": {
               "default": null,
               "enum": [
                  "first",
                  "second",
                  "last"
               ],
               "title": "Upgraderolloutorder",
               "type": "string"
            },
            "PendingModifiedValues": {
               "$ref": "#/$defs/RDSPendingModifiedValues",
               "default": null
            },
            "LatestRestorableTime": {
               "default": null,
               "format": "date-time",
               "title": "Latestrestorabletime",
               "type": "string"
            },
            "ReadReplicaSourceDBInstanceIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbinstanceidentifier",
               "type": "string"
            },
            "ReadReplicaDBInstanceIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbinstanceidentifiers",
               "type": "array"
            },
            "ReadReplicaDBClusterIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbclusteridentifiers",
               "type": "array"
            },
            "ReplicaMode": {
               "anyOf": [
                  {
                     "enum": [
                        "open-read-only",
                        "mounted"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Replicamode"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "OptionGroupMemberships": {
               "items": {
                  "$ref": "#/$defs/OptionGroupMembership"
               },
               "title": "Optiongroupmemberships",
               "type": "array"
            },
            "CharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Charactersetname"
            },
            "NcharCharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ncharcharactersetname"
            },
            "SecondaryAvailabilityZone": {
               "default": null,
               "title": "Secondaryavailabilityzone",
               "type": "string"
            },
            "StatusInfos": {
               "items": {
                  "$ref": "#/$defs/DBInstanceStatusInfo"
               },
               "title": "Statusinfos",
               "type": "array"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "StorageEncryptionType": {
               "default": null,
               "enum": [
                  "none",
                  "sse-kms",
                  "sse-rds"
               ],
               "title": "Storageencryptiontype",
               "type": "string"
            },
            "TdeCredentialArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tdecredentialarn"
            },
            "DBClusterIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbclusteridentifier"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            },
            "DbiResourceId": {
               "default": null,
               "title": "Dbiresourceid",
               "type": "string"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DomainMemberships": {
               "items": {
                  "$ref": "#/$defs/DomainMembership"
               },
               "title": "Domainmemberships",
               "type": "array"
            },
            "CopyTagsToSnapshot": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Copytagstosnapshot"
            },
            "MonitoringInterval": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringinterval"
            },
            "EnhancedMonitoringResourceArn": {
               "default": null,
               "title": "Enhancedmonitoringresourcearn",
               "type": "string"
            },
            "MonitoringRoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringrolearn"
            },
            "PromotionTier": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Promotiontier"
            },
            "DBInstanceArn": {
               "default": null,
               "title": "Dbinstancearn",
               "type": "string"
            },
            "Timezone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Timezone"
            },
            "DatabaseInsightsMode": {
               "anyOf": [
                  {
                     "enum": [
                        "standard",
                        "advanced"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Databaseinsightsmode"
            },
            "PerformanceInsightsKMSKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightskmskeyid"
            },
            "PerformanceInsightsRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsretentionperiod"
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "DeletionProtection": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Deletionprotection"
            },
            "AssociatedRoles": {
               "items": {
                  "$ref": "#/$defs/DBInstanceRole"
               },
               "title": "Associatedroles",
               "type": "array"
            },
            "ListenerEndpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "default": null,
               "format": "date-time",
               "title": "Resumefullautomationmodetime",
               "type": "string"
            },
            "NetworkType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Networktype"
            },
            "ActivityStreamStatus": {
               "default": null,
               "enum": [
                  "stopped",
                  "starting",
                  "started",
                  "stopping"
               ],
               "title": "Activitystreamstatus",
               "type": "string"
            },
            "ActivityStreamKmsKeyId": {
               "default": null,
               "title": "Activitystreamkmskeyid",
               "type": "string"
            },
            "ActivityStreamKinesisStreamName": {
               "default": null,
               "title": "Activitystreamkinesisstreamname",
               "type": "string"
            },
            "ActivityStreamMode": {
               "default": null,
               "enum": [
                  "sync",
                  "async"
               ],
               "title": "Activitystreammode",
               "type": "string"
            },
            "ActivityStreamEngineNativeAuditFieldsIncluded": {
               "default": null,
               "title": "Activitystreamenginenativeauditfieldsincluded",
               "type": "boolean"
            },
            "AwsBackupRecoveryPointArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Awsbackuprecoverypointarn"
            },
            "DBInstanceAutomatedBackupsReplications": {
               "items": {
                  "$ref": "#/$defs/DBInstanceAutomatedBackupsReplication"
               },
               "title": "Dbinstanceautomatedbackupsreplications",
               "type": "array"
            },
            "BackupTarget": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backuptarget"
            },
            "AutomaticRestartTime": {
               "default": null,
               "format": "date-time",
               "title": "Automaticrestarttime",
               "type": "string"
            },
            "CustomIamInstanceProfile": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customiaminstanceprofile"
            },
            "ActivityStreamPolicyStatus": {
               "default": null,
               "enum": [
                  "locked",
                  "unlocked",
                  "locking-policy",
                  "unlocking-policy"
               ],
               "title": "Activitystreampolicystatus",
               "type": "string"
            },
            "CertificateDetails": {
               "$ref": "#/$defs/RDSCertificateDetails",
               "default": null
            },
            "DBSystemId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsystemid"
            },
            "MasterUserSecret": {
               "$ref": "#/$defs/RDSMasterUserSecret",
               "default": null
            },
            "ReadReplicaSourceDBClusterIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbclusteridentifier",
               "type": "string"
            },
            "PercentProgress": {
               "default": null,
               "title": "Percentprogress",
               "type": "string"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "IsStorageConfigUpgradeAvailable": {
               "default": null,
               "title": "Isstorageconfigupgradeavailable",
               "type": "boolean"
            },
            "EngineLifecycleSupport": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Enginelifecyclesupport"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolumeOutput"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            },
            "StorageVolumeStatus": {
               "default": null,
               "title": "Storagevolumestatus",
               "type": "string"
            }
         },
         "required": [
            "DBInstanceIdentifier",
            "DBInstanceClass",
            "MultiAZ",
            "Engine",
            "EngineVersion",
            "PubliclyAccessible"
         ],
         "title": "DBInstance",
         "type": "object"
      },
      "DBInstanceAutomatedBackupsReplication": {
         "description": "Automated backups of a DB instance replicated to another Amazon Web Services Region.\n\nThey consist of system backups, transaction logs, and database instance properties.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceAutomatedBackupsArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceautomatedbackupsarn"
            }
         },
         "title": "DBInstanceAutomatedBackupsReplication",
         "type": "object"
      },
      "DBInstanceRole": {
         "description": "Information about an Amazon Web Services Identity and Access Management (IAM) role\nthat is associated with a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "RoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rolearn"
            },
            "FeatureName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Featurename"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBInstanceRole",
         "type": "object"
      },
      "DBInstanceStatusInfo": {
         "description": "Provides a list of status information for an instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "StatusType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Statustype"
            },
            "Normal": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Normal"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "Message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message"
            }
         },
         "title": "DBInstanceStatusInfo",
         "type": "object"
      },
      "DBParameterGroupStatus": {
         "description": "The status of the DB parameter group.\n\nThis data type is used as a response element in the following actions:\n\n* ``CreateDBInstance``\n* ``CreateDBInstanceReadReplica``\n* ``DeleteDBInstance``\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBParameterGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbparametergroupname"
            },
            "ParameterApplyStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Parameterapplystatus"
            }
         },
         "title": "DBParameterGroupStatus",
         "type": "object"
      },
      "DBSecurityGroupMembership": {
         "description": "This data type is used as a response element in the following actions:\n\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceToPointInTime``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSecurityGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsecuritygroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBSecurityGroupMembership",
         "type": "object"
      },
      "DomainMembership": {
         "description": "An Active Directory Domain membership record associated with the DB instance or\ncluster.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Domain"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "FQDN": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fqdn"
            },
            "IAMRoleName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamrolename"
            },
            "OU": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ou"
            },
            "AuthSecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authsecretarn"
            },
            "DnsIps": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dnsips"
            }
         },
         "title": "DomainMembership",
         "type": "object"
      },
      "OptionGroupMembership": {
         "description": "Provides information on the option groups the DB instance is a member of.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "OptionGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Optiongroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "OptionGroupMembership",
         "type": "object"
      },
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "ProcessorFeature": {
         "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "ProcessorFeature",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSCertificateDetails": {
         "description": "The details of the DB instance\u2019s server certificate.\n\nFor more information, see `Using SSL/TLS to encrypt a connection to a DB\ninstance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon RDS User Guide*\nand  `Using SSL/TLS to encrypt a connection to a DB\ncluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon Aurora User\nGuide*.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "CAIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Caidentifier"
            },
            "ValidTill": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Validtill"
            }
         },
         "title": "RDSCertificateDetails",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSEndpoint": {
         "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a\nresponse element in the following actions:\n\n* ``CreateDBInstance``\n* ``DescribeDBInstances``\n* ``DeleteDBInstance``\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "HostedZoneId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Hostedzoneid"
            }
         },
         "title": "RDSEndpoint",
         "type": "object"
      },
      "RDSMasterUserSecret": {
         "description": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the\nmaster user password.\n\nFor more information, see\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_\nin the *Amazon RDS User Guide*    and\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_\nin the *Amazon Aurora\nUser Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretarn"
            },
            "SecretStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretstatus"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            }
         },
         "title": "RDSMasterUserSecret",
         "type": "object"
      },
      "RDSPendingCloudwatchLogsExports": {
         "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "LogTypesToEnable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestoenable"
            },
            "LogTypesToDisable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestodisable"
            }
         },
         "title": "RDSPendingCloudwatchLogsExports",
         "type": "object"
      },
      "RDSPendingModifiedValues": {
         "description": "This data type is used as a response element in the ``ModifyDBInstance`` operation\nand contains changes that will be applied during the next maintenance window.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceClass": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceclass"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "MasterUserPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masteruserpassword"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backupretentionperiod"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multiaz"
            },
            "EngineVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engineversion"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "DBInstanceIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceidentifier"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DBSubnetGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsubnetgroupname"
            },
            "PendingCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSPendingCloudwatchLogsExports"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resumefullautomationmodetime"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "Engine": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engine"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolume"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            }
         },
         "title": "RDSPendingModifiedValues",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      },
      "Tag": {
         "description": "The metadata that you apply to a resource to help you categorize and\norganize them. Each tag consists of a key and an optional value. You define\nthem.\n\nThe following basic restrictions apply to tags:\n\n* Maximum number of tags per resource - 50\n* For each resource, each tag key must be unique, and each tag key can have\n  only one value.\n* Maximum key length - 128 Unicode characters in UTF-8\n* Maximum value length - 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n  remember that other services may have restrictions on allowed characters.\n  Generally allowed characters are: letters, numbers, and spaces representable in\n  UTF-8, and the following characters: + - = . _ : / @.\n* Tag keys and values are case-sensitive.\n* Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such\n  as a prefix for either keys or values as it is reserved for Amazon Web Services\n  use. You cannot edit or delete tag keys or values with this prefix. Tags with\n  this prefix do not count against your tags per resource limit.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Key"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "Tag",
         "type": "object"
      },
      "VpcSecurityGroupMembership": {
         "description": "Used as a response element for queries on virtual private cloud (VPC) security group\nmembership.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VpcSecurityGroupId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Vpcsecuritygroupid"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "VpcSecurityGroupMembership",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field RDSDBInstance: DBInstance = None (alias 'DBInstance')

Contains the details of an Amazon RDS DB instance.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.ModifyAdditionalStorageVolume[source]

Bases: Boto3Model

Contains details about the modification of an additional storage volume.

Show JSON schema
{
   "title": "ModifyAdditionalStorageVolume",
   "description": "Contains details about the modification of an additional storage volume.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "VolumeName": {
         "title": "Volumename",
         "type": "string"
      },
      "AllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Allocatedstorage"
      },
      "IOPS": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Iops"
      },
      "MaxAllocatedStorage": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Maxallocatedstorage"
      },
      "StorageThroughput": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagethroughput"
      },
      "StorageType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Storagetype"
      },
      "SetForDelete": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Setfordelete"
      }
   },
   "required": [
      "VolumeName"
   ]
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field AllocatedStorage: int | None = None

The amount of storage allocated for the additional storage volume, in gibibytes (GiB).

The minimum is 20 GiB. The maximum is 65,536 GiB (64 TiB).

field IOPS: int | None = None

The number of I/O operations per second (IOPS) provisioned for the additional storage volume.

This setting is only supported for Provisioned IOPS SSD (io1 and io2) storage types.

field MaxAllocatedStorage: int | None = None

The upper limit in gibibytes (GiB) to which RDS can automatically scale the storage of the additional storage volume.

You must provide a value greater than or equal to AllocatedStorage.

field SetForDelete: bool | None = None

Indicates whether to delete the additional storage volume.

The value true schedules the volume for deletion. You can delete an additional storage volume only when it doesn’t contain database files or other data.

field StorageThroughput: int | None = None

The storage throughput value for the additional storage volume, in mebibytes per second (MiBps).

This setting applies only to the General Purpose SSD (gp3) storage type.

field StorageType: str | None = None

The new storage type for the additional storage volume.

field VolumeName: str [Required]

The name of the additional storage volume that you want to modify.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.ModifyDBInstanceResult[source]

Bases: Boto3Model

Show JSON schema
{
   "title": "ModifyDBInstanceResult",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBInstance": {
         "$ref": "#/$defs/DBInstance",
         "default": null
      }
   },
   "$defs": {
      "AdditionalStorageVolume": {
         "description": "Contains details about an additional storage volume for a DB instance.\n\nRDS support additional storage volumes for RDS for Oracle and RDS for SQL Server.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "title": "Volumename",
               "type": "string"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "required": [
            "VolumeName"
         ],
         "title": "AdditionalStorageVolume",
         "type": "object"
      },
      "AdditionalStorageVolumeOutput": {
         "description": "Contains information about an additional storage volume for a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VolumeName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Volumename"
            },
            "StorageVolumeStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagevolumestatus"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "IOPS": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            }
         },
         "title": "AdditionalStorageVolumeOutput",
         "type": "object"
      },
      "DBInstance": {
         "description": "Contains the details of an Amazon RDS DB instance.\n\nThis data type is used as a response element in the operations ``CreateDBInstance``, ``CreateDBInstanceReadReplica``,\n``DeleteDBInstance``, ``DescribeDBInstances``, ``ModifyDBInstance``, ``PromoteReadReplica``, ``RebootDBInstance``,\n``RestoreDBInstanceFromDBSnapshot``, ``RestoreDBInstanceFromS3``, ``RestoreDBInstanceToPointInTime``,\n``StartDBInstance``, and ``StopDBInstance``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceIdentifier": {
               "title": "Dbinstanceidentifier",
               "type": "string"
            },
            "DBInstanceClass": {
               "title": "Dbinstanceclass",
               "type": "string"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Multiaz"
            },
            "Engine": {
               "title": "Engine",
               "type": "string"
            },
            "EngineVersion": {
               "title": "Engineversion",
               "type": "string"
            },
            "AutoMinorVersionUpgrade": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Autominorversionupgrade"
            },
            "PubliclyAccessible": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Publiclyaccessible"
            },
            "StorageEncrypted": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Storageencrypted"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "title": "Backupretentionperiod"
            },
            "DbInstancePort": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceport"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "EnabledCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Enabledcloudwatchlogsexports"
            },
            "TagList": {
               "items": {
                  "$ref": "#/$defs/Tag"
               },
               "title": "Taglist",
               "type": "array"
            },
            "CustomerOwnedIpEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customerownedipenabled"
            },
            "PerformanceInsightsEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsenabled"
            },
            "DBSubnetGroup": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSDBSubnetGroup"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "DBInstanceStatus": {
               "default": null,
               "title": "Dbinstancestatus",
               "type": "string"
            },
            "MasterUsername": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masterusername"
            },
            "DBName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbname"
            },
            "Endpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "InstanceCreateTime": {
               "default": null,
               "format": "date-time",
               "title": "Instancecreatetime",
               "type": "string"
            },
            "PreferredBackupWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredbackupwindow"
            },
            "DBSecurityGroups": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/DBSecurityGroupMembership"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dbsecuritygroups"
            },
            "VpcSecurityGroups": {
               "items": {
                  "$ref": "#/$defs/VpcSecurityGroupMembership"
               },
               "title": "Vpcsecuritygroups",
               "type": "array"
            },
            "DBParameterGroups": {
               "items": {
                  "$ref": "#/$defs/DBParameterGroupStatus"
               },
               "title": "Dbparametergroups",
               "type": "array"
            },
            "AvailabilityZone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Availabilityzone"
            },
            "PreferredMaintenanceWindow": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Preferredmaintenancewindow"
            },
            "UpgradeRolloutOrder": {
               "default": null,
               "enum": [
                  "first",
                  "second",
                  "last"
               ],
               "title": "Upgraderolloutorder",
               "type": "string"
            },
            "PendingModifiedValues": {
               "$ref": "#/$defs/RDSPendingModifiedValues",
               "default": null
            },
            "LatestRestorableTime": {
               "default": null,
               "format": "date-time",
               "title": "Latestrestorabletime",
               "type": "string"
            },
            "ReadReplicaSourceDBInstanceIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbinstanceidentifier",
               "type": "string"
            },
            "ReadReplicaDBInstanceIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbinstanceidentifiers",
               "type": "array"
            },
            "ReadReplicaDBClusterIdentifiers": {
               "items": {
                  "type": "string"
               },
               "title": "Readreplicadbclusteridentifiers",
               "type": "array"
            },
            "ReplicaMode": {
               "anyOf": [
                  {
                     "enum": [
                        "open-read-only",
                        "mounted"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Replicamode"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "OptionGroupMemberships": {
               "items": {
                  "$ref": "#/$defs/OptionGroupMembership"
               },
               "title": "Optiongroupmemberships",
               "type": "array"
            },
            "CharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Charactersetname"
            },
            "NcharCharacterSetName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ncharcharactersetname"
            },
            "SecondaryAvailabilityZone": {
               "default": null,
               "title": "Secondaryavailabilityzone",
               "type": "string"
            },
            "StatusInfos": {
               "items": {
                  "$ref": "#/$defs/DBInstanceStatusInfo"
               },
               "title": "Statusinfos",
               "type": "array"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "StorageEncryptionType": {
               "default": null,
               "enum": [
                  "none",
                  "sse-kms",
                  "sse-rds"
               ],
               "title": "Storageencryptiontype",
               "type": "string"
            },
            "TdeCredentialArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tdecredentialarn"
            },
            "DBClusterIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbclusteridentifier"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            },
            "DbiResourceId": {
               "default": null,
               "title": "Dbiresourceid",
               "type": "string"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DomainMemberships": {
               "items": {
                  "$ref": "#/$defs/DomainMembership"
               },
               "title": "Domainmemberships",
               "type": "array"
            },
            "CopyTagsToSnapshot": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Copytagstosnapshot"
            },
            "MonitoringInterval": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringinterval"
            },
            "EnhancedMonitoringResourceArn": {
               "default": null,
               "title": "Enhancedmonitoringresourcearn",
               "type": "string"
            },
            "MonitoringRoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Monitoringrolearn"
            },
            "PromotionTier": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Promotiontier"
            },
            "DBInstanceArn": {
               "default": null,
               "title": "Dbinstancearn",
               "type": "string"
            },
            "Timezone": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Timezone"
            },
            "DatabaseInsightsMode": {
               "anyOf": [
                  {
                     "enum": [
                        "standard",
                        "advanced"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Databaseinsightsmode"
            },
            "PerformanceInsightsKMSKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightskmskeyid"
            },
            "PerformanceInsightsRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Performanceinsightsretentionperiod"
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "DeletionProtection": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Deletionprotection"
            },
            "AssociatedRoles": {
               "items": {
                  "$ref": "#/$defs/DBInstanceRole"
               },
               "title": "Associatedroles",
               "type": "array"
            },
            "ListenerEndpoint": {
               "$ref": "#/$defs/RDSEndpoint",
               "default": null
            },
            "MaxAllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Maxallocatedstorage"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "default": null,
               "format": "date-time",
               "title": "Resumefullautomationmodetime",
               "type": "string"
            },
            "NetworkType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Networktype"
            },
            "ActivityStreamStatus": {
               "default": null,
               "enum": [
                  "stopped",
                  "starting",
                  "started",
                  "stopping"
               ],
               "title": "Activitystreamstatus",
               "type": "string"
            },
            "ActivityStreamKmsKeyId": {
               "default": null,
               "title": "Activitystreamkmskeyid",
               "type": "string"
            },
            "ActivityStreamKinesisStreamName": {
               "default": null,
               "title": "Activitystreamkinesisstreamname",
               "type": "string"
            },
            "ActivityStreamMode": {
               "default": null,
               "enum": [
                  "sync",
                  "async"
               ],
               "title": "Activitystreammode",
               "type": "string"
            },
            "ActivityStreamEngineNativeAuditFieldsIncluded": {
               "default": null,
               "title": "Activitystreamenginenativeauditfieldsincluded",
               "type": "boolean"
            },
            "AwsBackupRecoveryPointArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Awsbackuprecoverypointarn"
            },
            "DBInstanceAutomatedBackupsReplications": {
               "items": {
                  "$ref": "#/$defs/DBInstanceAutomatedBackupsReplication"
               },
               "title": "Dbinstanceautomatedbackupsreplications",
               "type": "array"
            },
            "BackupTarget": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backuptarget"
            },
            "AutomaticRestartTime": {
               "default": null,
               "format": "date-time",
               "title": "Automaticrestarttime",
               "type": "string"
            },
            "CustomIamInstanceProfile": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Customiaminstanceprofile"
            },
            "ActivityStreamPolicyStatus": {
               "default": null,
               "enum": [
                  "locked",
                  "unlocked",
                  "locking-policy",
                  "unlocking-policy"
               ],
               "title": "Activitystreampolicystatus",
               "type": "string"
            },
            "CertificateDetails": {
               "$ref": "#/$defs/RDSCertificateDetails",
               "default": null
            },
            "DBSystemId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsystemid"
            },
            "MasterUserSecret": {
               "$ref": "#/$defs/RDSMasterUserSecret",
               "default": null
            },
            "ReadReplicaSourceDBClusterIdentifier": {
               "default": null,
               "title": "Readreplicasourcedbclusteridentifier",
               "type": "string"
            },
            "PercentProgress": {
               "default": null,
               "title": "Percentprogress",
               "type": "string"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "IsStorageConfigUpgradeAvailable": {
               "default": null,
               "title": "Isstorageconfigupgradeavailable",
               "type": "boolean"
            },
            "EngineLifecycleSupport": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Enginelifecyclesupport"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolumeOutput"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            },
            "StorageVolumeStatus": {
               "default": null,
               "title": "Storagevolumestatus",
               "type": "string"
            }
         },
         "required": [
            "DBInstanceIdentifier",
            "DBInstanceClass",
            "MultiAZ",
            "Engine",
            "EngineVersion",
            "PubliclyAccessible"
         ],
         "title": "DBInstance",
         "type": "object"
      },
      "DBInstanceAutomatedBackupsReplication": {
         "description": "Automated backups of a DB instance replicated to another Amazon Web Services Region.\n\nThey consist of system backups, transaction logs, and database instance properties.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceAutomatedBackupsArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceautomatedbackupsarn"
            }
         },
         "title": "DBInstanceAutomatedBackupsReplication",
         "type": "object"
      },
      "DBInstanceRole": {
         "description": "Information about an Amazon Web Services Identity and Access Management (IAM) role\nthat is associated with a DB instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "RoleArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Rolearn"
            },
            "FeatureName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Featurename"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBInstanceRole",
         "type": "object"
      },
      "DBInstanceStatusInfo": {
         "description": "Provides a list of status information for an instance.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "StatusType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Statustype"
            },
            "Normal": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Normal"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "Message": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Message"
            }
         },
         "title": "DBInstanceStatusInfo",
         "type": "object"
      },
      "DBParameterGroupStatus": {
         "description": "The status of the DB parameter group.\n\nThis data type is used as a response element in the following actions:\n\n* ``CreateDBInstance``\n* ``CreateDBInstanceReadReplica``\n* ``DeleteDBInstance``\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBParameterGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbparametergroupname"
            },
            "ParameterApplyStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Parameterapplystatus"
            }
         },
         "title": "DBParameterGroupStatus",
         "type": "object"
      },
      "DBSecurityGroupMembership": {
         "description": "This data type is used as a response element in the following actions:\n\n* ``ModifyDBInstance``\n* ``RebootDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceToPointInTime``",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSecurityGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsecuritygroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "DBSecurityGroupMembership",
         "type": "object"
      },
      "DomainMembership": {
         "description": "An Active Directory Domain membership record associated with the DB instance or\ncluster.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Domain": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Domain"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            },
            "FQDN": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Fqdn"
            },
            "IAMRoleName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamrolename"
            },
            "OU": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Ou"
            },
            "AuthSecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Authsecretarn"
            },
            "DnsIps": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Dnsips"
            }
         },
         "title": "DomainMembership",
         "type": "object"
      },
      "OptionGroupMembership": {
         "description": "Provides information on the option groups the DB instance is a member of.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "OptionGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Optiongroupname"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "OptionGroupMembership",
         "type": "object"
      },
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "ProcessorFeature": {
         "description": "Contains the processor features of a DB instance class.\n\nTo specify the number of CPU cores, use the ``coreCount`` feature name for the ``Name`` parameter. To specify the number\nof threads per core, use the ``threadsPerCore`` feature name for the ``Name`` parameter.\n\nYou can set the processor features of the DB instance class for a DB instance when you call one of the following\nactions:\n\n* ``CreateDBInstance``\n* ``ModifyDBInstance``\n* ``RestoreDBInstanceFromDBSnapshot``\n* ``RestoreDBInstanceFromS3``\n* ``RestoreDBInstanceToPointInTime``\n\nYou can view the valid processor values for a particular instance class by calling the\n``DescribeOrderableDBInstanceOptions`` action and specifying the instance class for the ``DBInstanceClass`` parameter.\n\nIn addition, you can use the following actions for DB instance class processor information:\n\n* ``DescribeDBInstances``\n* ``DescribeDBSnapshots``\n* ``DescribeValidDBInstanceModifications``\n\nIf you call ``DescribeDBInstances``, ``ProcessorFeature`` returns non-null values only if the following conditions are\nmet:\n\n* You are accessing an Oracle or SQL Server DB instance.\n* Your Oracle or SQL Server DB instance class supports configuring the number of CPU cores and threads per core.\n* The current number CPU cores and threads is set to a non-default value.\n\nFor more information, see  `Configuring the processor for a DB instance class in RDS for\nOracle <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`_,\n`Optimizing your RDS for SQL Server\nCPU <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Concepts.General.OptimizeCPU.html>`_, and `DB\ninstance classes <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html>`_ in the *Amazon\nRDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "ProcessorFeature",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSCertificateDetails": {
         "description": "The details of the DB instance\u2019s server certificate.\n\nFor more information, see `Using SSL/TLS to encrypt a connection to a DB\ninstance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon RDS User Guide*\nand  `Using SSL/TLS to encrypt a connection to a DB\ncluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html>`_ in the *Amazon Aurora User\nGuide*.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "CAIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Caidentifier"
            },
            "ValidTill": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Validtill"
            }
         },
         "title": "RDSCertificateDetails",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSEndpoint": {
         "description": "This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a\nresponse element in the following actions:\n\n* ``CreateDBInstance``\n* ``DescribeDBInstances``\n* ``DeleteDBInstance``\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Address": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Address"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "HostedZoneId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Hostedzoneid"
            }
         },
         "title": "RDSEndpoint",
         "type": "object"
      },
      "RDSMasterUserSecret": {
         "description": "Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the\nmaster user password.\n\nFor more information, see\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html>`_\nin the *Amazon RDS User Guide*    and\n`Password management with Amazon Web Services Secrets Manager <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html>`_\nin the *Amazon Aurora\nUser Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SecretArn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretarn"
            },
            "SecretStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Secretstatus"
            },
            "KmsKeyId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Kmskeyid"
            }
         },
         "title": "RDSMasterUserSecret",
         "type": "object"
      },
      "RDSPendingCloudwatchLogsExports": {
         "description": "A list of the log types whose configuration is still pending.\n\nIn other words, these log types are in the process of being activated or\ndeactivated.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "LogTypesToEnable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestoenable"
            },
            "LogTypesToDisable": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Logtypestodisable"
            }
         },
         "title": "RDSPendingCloudwatchLogsExports",
         "type": "object"
      },
      "RDSPendingModifiedValues": {
         "description": "This data type is used as a response element in the ``ModifyDBInstance`` operation\nand contains changes that will be applied during the next maintenance window.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBInstanceClass": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceclass"
            },
            "AllocatedStorage": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Allocatedstorage"
            },
            "MasterUserPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Masteruserpassword"
            },
            "Port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Port"
            },
            "BackupRetentionPeriod": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Backupretentionperiod"
            },
            "MultiAZ": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multiaz"
            },
            "EngineVersion": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engineversion"
            },
            "LicenseModel": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Licensemodel"
            },
            "Iops": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iops"
            },
            "StorageThroughput": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagethroughput"
            },
            "DBInstanceIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbinstanceidentifier"
            },
            "StorageType": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Storagetype"
            },
            "CACertificateIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Cacertificateidentifier"
            },
            "DBSubnetGroupName": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dbsubnetgroupname"
            },
            "PendingCloudwatchLogsExports": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSPendingCloudwatchLogsExports"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "ProcessorFeatures": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/ProcessorFeature"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Processorfeatures"
            },
            "AutomationMode": {
               "anyOf": [
                  {
                     "enum": [
                        "full",
                        "all-paused"
                     ],
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Automationmode"
            },
            "ResumeFullAutomationModeTime": {
               "anyOf": [
                  {
                     "format": "date-time",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Resumefullautomationmodetime"
            },
            "MultiTenant": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Multitenant"
            },
            "IAMDatabaseAuthenticationEnabled": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Iamdatabaseauthenticationenabled"
            },
            "DedicatedLogVolume": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Dedicatedlogvolume"
            },
            "Engine": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Engine"
            },
            "AdditionalStorageVolumes": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/AdditionalStorageVolume"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Additionalstoragevolumes"
            }
         },
         "title": "RDSPendingModifiedValues",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      },
      "Tag": {
         "description": "The metadata that you apply to a resource to help you categorize and\norganize them. Each tag consists of a key and an optional value. You define\nthem.\n\nThe following basic restrictions apply to tags:\n\n* Maximum number of tags per resource - 50\n* For each resource, each tag key must be unique, and each tag key can have\n  only one value.\n* Maximum key length - 128 Unicode characters in UTF-8\n* Maximum value length - 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n  remember that other services may have restrictions on allowed characters.\n  Generally allowed characters are: letters, numbers, and spaces representable in\n  UTF-8, and the following characters: + - = . _ : / @.\n* Tag keys and values are case-sensitive.\n* Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such\n  as a prefix for either keys or values as it is reserved for Amazon Web Services\n  use. You cannot edit or delete tag keys or values with this prefix. Tags with\n  this prefix do not count against your tags per resource limit.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Key"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "Tag",
         "type": "object"
      },
      "VpcSecurityGroupMembership": {
         "description": "Used as a response element for queries on virtual private cloud (VPC) security group\nmembership.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "VpcSecurityGroupId": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Vpcsecuritygroupid"
            },
            "Status": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Status"
            }
         },
         "title": "VpcSecurityGroupMembership",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field RDSDBInstance: DBInstance = None (alias 'DBInstance')

Contains the details of an Amazon RDS DB instance.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.ModifyDBSubnetGroupResult[source]

Bases: Boto3Model

Show JSON schema
{
   "title": "ModifyDBSubnetGroupResult",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "DBSubnetGroup": {
         "anyOf": [
            {
               "$ref": "#/$defs/RDSDBSubnetGroup"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "Outpost": {
         "description": "A data type that represents an Outpost.\n\nFor more information about RDS on Outposts, see\n`Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`_\nin the *Amazon RDS User Guide.*",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Arn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Arn"
            }
         },
         "title": "Outpost",
         "type": "object"
      },
      "RDSAvailabilityZone": {
         "description": "Contains Availability Zone information.\n\nThis data type is used as an element in the ``OrderableDBInstanceOption`` data type.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Name": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Name"
            }
         },
         "title": "RDSAvailabilityZone",
         "type": "object"
      },
      "RDSDBSubnetGroup": {
         "description": "Contains the details of an Amazon RDS DB subnet group.\n\nThis data type is used as a response element in the ``DescribeDBSubnetGroups`` action.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "DBSubnetGroupName": {
               "title": "Dbsubnetgroupname",
               "type": "string"
            },
            "DBSubnetGroupDescription": {
               "title": "Dbsubnetgroupdescription",
               "type": "string"
            },
            "Subnets": {
               "items": {
                  "$ref": "#/$defs/RDSSubnet"
               },
               "title": "Subnets",
               "type": "array"
            },
            "VpcId": {
               "title": "Vpcid",
               "type": "string"
            },
            "SubnetGroupStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "Complete",
               "title": "Subnetgroupstatus"
            },
            "DBSubnetGroupArn": {
               "default": null,
               "title": "Dbsubnetgrouparn",
               "type": "string"
            },
            "SupportedNetworkTypes": {
               "items": {
                  "type": "string"
               },
               "title": "Supportednetworktypes",
               "type": "array"
            }
         },
         "required": [
            "DBSubnetGroupName",
            "DBSubnetGroupDescription",
            "Subnets",
            "VpcId"
         ],
         "title": "RDSDBSubnetGroup",
         "type": "object"
      },
      "RDSSubnet": {
         "description": "This data type is used as a response element for the ``DescribeDBSubnetGroups``\noperation.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "SubnetIdentifier": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetidentifier"
            },
            "SubnetAvailabilityZone": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RDSAvailabilityZone"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetOutpost": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Outpost"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "SubnetStatus": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Subnetstatus"
            }
         },
         "title": "RDSSubnet",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field DBSubnetGroup: RDSDBSubnetGroup | None = None

Contains the details of an Amazon RDS DB subnet group.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

pydantic model botocraft.services.rds.RDSTagSpecification[source]

Bases: TagsDictMixin, Boto3Model

The tags to apply to resources when creating or modifying a DB instance or DB cluster.

When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Show JSON schema
{
   "title": "RDSTagSpecification",
   "description": "The tags to apply to resources when creating or modifying a DB instance or DB\ncluster.\n\nWhen you specify a tag, you must specify the resource type to tag, otherwise the\nrequest will fail.",
   "type": "object",
   "properties": {
      "session": {
         "anyOf": [
            {},
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Session"
      },
      "ResourceType": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Resourcetype"
      },
      "Tags": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/Tag"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "title": "Tags"
      }
   },
   "$defs": {
      "Tag": {
         "description": "The metadata that you apply to a resource to help you categorize and\norganize them. Each tag consists of a key and an optional value. You define\nthem.\n\nThe following basic restrictions apply to tags:\n\n* Maximum number of tags per resource - 50\n* For each resource, each tag key must be unique, and each tag key can have\n  only one value.\n* Maximum key length - 128 Unicode characters in UTF-8\n* Maximum value length - 256 Unicode characters in UTF-8\n* If your tagging schema is used across multiple services and resources,\n  remember that other services may have restrictions on allowed characters.\n  Generally allowed characters are: letters, numbers, and spaces representable in\n  UTF-8, and the following characters: + - = . _ : / @.\n* Tag keys and values are case-sensitive.\n* Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such\n  as a prefix for either keys or values as it is reserved for Amazon Web Services\n  use. You cannot edit or delete tag keys or values with this prefix. Tags with\n  this prefix do not count against your tags per resource limit.",
         "properties": {
            "session": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Session"
            },
            "Key": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Key"
            },
            "Value": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Value"
            }
         },
         "title": "Tag",
         "type": "object"
      }
   }
}

Config:
  • validate_assignment: bool = True

  • arbitrary_types_allowed: bool = True

Fields:
field ResourceType: str | None = None

The type of resource to tag on creation.

field Tags: builtins.list[Tag] | None [Optional]

A list of tags.

field session: Any | None = None

The boto3 session to use for this model. This is set by the manager, and is used in relationships. We have to use Any here because we pydantic complains vociferously if we use boto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.

tag_class

alias of Tag

classmethod model_construct(_fields_set: set[str] | None = None, **values: Any) Self

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

classmethod model_validate_strings(obj: Any, *, strict: bool | None = None, context: Any | None = None, by_alias: bool | None = None, by_name: bool | None = None) Self

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj – The object containing string data to validate.

  • strict – Whether to enforce types strictly.

  • context – Extra variables to pass to the validator.

  • by_alias – Whether to use the field’s alias when validating against the provided input data.

  • by_name – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

set_session(session: Session) None

Set the boto3 session for this model.

Parameters:

session – The boto3 session to use.

Returns:

The model instance.

transform(attribute: str, transformer: str | None) Any

Transform an attribute using a regular expression into something else before it is returned.

Important

This only makes sense for attributes that are strings.

transformer is a regular expression that will be used to transform the value of the attribute.

  • If the attribute is None, it will be returned verbatim.

  • If transformer is None, the attribute will be returned verbatim.

  • If transformer has no named groups, the attribute will be replaced with the value of the first group.

  • If transformer has named groups, the attribute will be replaced with a dictionary of the named groups.

Raises:
  • ValueError – If the attribute does not exist on the model.

  • RuntimeError – If the transformer fails to match the attribute value.

Parameters:
  • attribute – The attribute to transform.

  • transformer – The regular expression to use to transform the attribute.

Returns:

The transformed attribute.

property tags: TagsDict

Get the tags for the model instance.

Returns:

The tags for the model instance.