DocDB (docdb)
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.docdb.DocDBCluster[source]
Bases:
TagsDictMixin,DocDBClusterModelMixin,PrimaryBoto3ModelDetailed information about a cluster.
Show JSON schema
{ "title": "DocDBCluster", "description": "Detailed information about a cluster.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 AssociatedRoles: builtins.list[DBClusterRole] [Optional]
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster.
(IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
- field AvailabilityZones: builtins.list[str] | None [Optional]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
- field BackupRetentionPeriod: int | None = None
Specifies the number of days for which automatic snapshots are retained.
- field ClusterCreateTime: datetime = None
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
- field DBClusterIdentifier: str | None = None
Contains a user-supplied cluster identifier.
This identifier is the unique key that identifies a cluster.
- field DBClusterMembers: builtins.list[DBClusterMember] [Optional]
Provides the list of instances that make up the cluster.
- field DBClusterParameterGroup: str = None
Specifies the name of the cluster parameter group for the cluster.
- field DBSubnetGroup: str | None = None
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
- field DbClusterResourceId: str = None
The Amazon Web Services Region-unique, immutable identifier for the cluster.
This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
- field DeletionProtection: bool | None = None
Specifies whether this cluster can be deleted.
If
DeletionProtectionis enabled, the cluster cannot be deleted unless it is modified andDeletionProtectionis disabled.DeletionProtectionprotects clusters from being accidentally deleted.
- field EarliestRestorableTime: datetime = None
The earliest time to which a database can be restored with point-in-time restore.
- field EnabledCloudwatchLogsExports: builtins.list[str] [Optional]
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
- field Endpoint: str = None
Specifies the connection endpoint for the primary instance of the cluster.
- field Engine: str | None = None
Provides the name of the database engine to be used for this cluster.
- field HostedZoneId: str = None
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- field IOOptimizedNextAllowedModificationTime: datetime = None
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
- field KmsKeyId: str | None = None
If
StorageEncryptedistrue, the KMS key identifier for the encrypted cluster.
- field LatestRestorableTime: datetime = None
Specifies the latest time to which a database can be restored with point-in-time restore.
- field MasterUserSecret: ClusterMasterUserSecret = None
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
- field MultiAZ: bool = None
Specifies whether the cluster has instances in multiple Availability Zones.
- field PreferredBackupWindow: str | None = None
Specifies 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
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- field ReadReplicaIdentifiers: builtins.list[str] [Optional]
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
- field ReaderEndpoint: str = None
The reader endpoint for the cluster.
The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
- field ReplicationSourceIdentifier: str = None
Contains the identifier of the source cluster if this cluster is a secondary cluster.
- field ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfigurationInfo | None = None
The scaling configuration of an Amazon DocumentDB Serverless cluster.
- field VpcSecurityGroups: builtins.list[VpcSecurityGroupMembership] [Optional]
Provides a list of virtual private cloud (VPC) security groups that the cluster 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
Anyhere because we pydantic complains vociferously if we useboto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.
- manager_class
alias of
DocDBClusterManager
- tag_class
alias of
Tag
- delete()
Delete the model.
- failover(TargetDBInstanceIdentifier: str | None = None) DocDBCluster[source]
Forces a failover for a cluster.
- Keyword Arguments:
TargetDBInstanceIdentifier – The name of the instance to promote to the primary instance.
- 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.
- start() DocDBCluster[source]
Restarts the stopped cluster that is specified by
DBClusterIdentifier.For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
- stop() DocDBCluster[source]
Stops the running cluster that is specified by
DBClusterIdentifier.The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
- 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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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
DBClusterArnattribute.- 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 kms_key: KMSKey | None
Return the KMS key that is used to encrypt the data in the DB cluster.
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 name: str | None
Return the name of the model. This is the value of the
DBClusterIdentifierattribute.- 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
DBClusterIdentifierattribute.- 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: DocDBSubnetGroup | 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.docdb.DocDBInstance[source]
Bases:
TagsDictMixin,PrimaryBoto3ModelDetailed information about an instance.
Show JSON schema
{ "title": "DocDBInstance", "description": "Detailed information about an instance.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "DBInstanceClass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceclass" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "DBInstanceStatus": { "default": null, "title": "Dbinstancestatus", "type": "string" }, "Endpoint": { "$ref": "#/$defs/DocDBEndpoint", "default": null }, "InstanceCreateTime": { "default": null, "format": "date-time", "title": "Instancecreatetime", "type": "string" }, "PreferredBackupWindow": { "default": null, "title": "Preferredbackupwindow", "type": "string" }, "BackupRetentionPeriod": { "default": null, "title": "Backupretentionperiod", "type": "integer" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "AvailabilityZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzone" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "PendingModifiedValues": { "$ref": "#/$defs/DocDBPendingModifiedValues", "default": null }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "EngineVersion": { "default": null, "title": "Engineversion", "type": "string" }, "AutoMinorVersionUpgrade": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Autominorversionupgrade" }, "PubliclyAccessible": { "default": null, "title": "Publiclyaccessible", "type": "boolean" }, "StatusInfos": { "items": { "$ref": "#/$defs/DBInstanceStatusInfo" }, "title": "Statusinfos", "type": "array" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "StorageEncrypted": { "default": null, "title": "Storageencrypted", "type": "boolean" }, "KmsKeyId": { "default": null, "title": "Kmskeyid", "type": "string" }, "DbiResourceId": { "default": null, "title": "Dbiresourceid", "type": "string" }, "CACertificateIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cacertificateidentifier" }, "CopyTagsToSnapshot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Copytagstosnapshot" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" }, "DBInstanceArn": { "default": null, "title": "Dbinstancearn", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "CertificateDetails": { "$ref": "#/$defs/DocDBCertificateDetails", "default": null }, "PerformanceInsightsEnabled": { "default": null, "title": "Performanceinsightsenabled", "type": "boolean" }, "PerformanceInsightsKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Performanceinsightskmskeyid" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "$defs": { "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" }, "DocDBCertificateDetails": { "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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": "DocDBCertificateDetails", "type": "object" }, "DocDBEndpoint": { "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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": "DocDBEndpoint", "type": "object" }, "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" }, "DocDBPendingModifiedValues": { "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "title": "DocDBPendingModifiedValues", "type": "object" }, "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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:
CertificateDetails (botocraft.services.docdb.DocDBCertificateDetails)DBSubnetGroup (botocraft.services.docdb.DocDBSubnetGroup | None)PendingModifiedValues (botocraft.services.docdb.DocDBPendingModifiedValues)StatusInfos (list[botocraft.services.docdb.DBInstanceStatusInfo])VpcSecurityGroups (list[botocraft.services.docdb.VpcSecurityGroupMembership])
- field AutoMinorVersionUpgrade: bool | None = None
Does not apply.
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
- field AvailabilityZone: str | None = None
Specifies the name of the Availability Zone that the instance is located in.
- field BackupRetentionPeriod: int = None
Specifies the number of days for which automatic snapshots are retained.
- field CACertificateIdentifier: str | None = None
The identifier of the CA certificate for this DB instance.
- field CertificateDetails: DocDBCertificateDetails = None
The details of the DB instance’s server certificate.
- field CopyTagsToSnapshot: bool | None = None
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
By default, tags are not copied.
- field DBClusterIdentifier: str | None = None
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
- field DBInstanceClass: str | None = None
Contains the name of the compute and memory capacity class of the instance.
- field DBInstanceIdentifier: str | None = None
Contains a user-provided database identifier.
This identifier is the unique key that identifies an instance.
- field DBSubnetGroup: DocDBSubnetGroup | None = None
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
- field DbiResourceId: str = None
The Amazon Web Services Region-unique, immutable identifier for the instance.
This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
- field EnabledCloudwatchLogsExports: builtins.list[str] [Optional]
A list of log types that this instance is configured to export to CloudWatch Logs.
- field Endpoint: DocDBEndpoint = None
Specifies the connection endpoint.
- field Engine: str | None = None
Provides the name of the database engine to be used for this instance.
- field InstanceCreateTime: datetime = None
Provides the date and time that the instance was created.
- field KmsKeyId: str = None
If
StorageEncryptedistrue, the KMS key identifier for the encrypted instance.
- field LatestRestorableTime: datetime = None
Specifies the latest time to which a database can be restored with point-in-time restore.
- field PendingModifiedValues: DocDBPendingModifiedValues = None
Specifies that changes to the instance are pending.
This element is included only when changes are pending. Specific changes are identified by subelements.
- field PerformanceInsightsEnabled: bool = None
Set to
trueif Amazon RDS Performance Insights is enabled for the DB instance, and otherwisefalse.
- field PerformanceInsightsKMSKeyId: str | None = None
The KMS key identifier for encryption of Performance Insights data.
The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
- field PreferredBackupWindow: str = None
Specifies 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
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
- field PromotionTier: int | None = None
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
- field PubliclyAccessible: bool = None
Not supported.
Amazon DocumentDB does not currently support public endpoints. The value of
PubliclyAccessibleis alwaysfalse.
- field StatusInfos: builtins.list[DBInstanceStatusInfo] [Optional]
The status of a read replica.
If the instance is not a read replica, this is blank.
- field VpcSecurityGroups: builtins.list[VpcSecurityGroupMembership] [Optional]
Provides a list of VPC security group elements that the 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
Anyhere because we pydantic complains vociferously if we useboto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.
- manager_class
alias of
DocDBInstanceManager
- 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.
- reboot(ForceFailover: bool | None = None) DocDBInstance[source]
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
- Keyword Arguments:
ForceFailover – When
true, the reboot is conducted through a Multi-AZ failover.
- 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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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
DBInstanceArnattribute.- Returns:
The ARN of the model instance.
- property kms_key: KMSKey | None
Return the KMS key that is used to encrypt the data in the DB cluster.
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 name: str | None
Return the name of the model. This is the value of the
DBInstanceIdentifierattribute.- 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
DBInstanceIdentifierattribute.- 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: DocDBSubnetGroup | 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.docdb.DocDBSubnetGroup[source]
Bases:
PrimaryBoto3ModelDetailed information about a subnet group.
Show JSON schema
{ "title": "DocDBSubnetGroup", "description": "Detailed information about a subnet group.", "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/Subnet" }, "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": { "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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" } }, "required": [ "DBSubnetGroupName", "DBSubnetGroupDescription", "Subnets", "VpcId" ] }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field Subnets: builtins.list[Subnet] [Required]
Detailed information about one or more subnets within a subnet group.
- field SupportedNetworkTypes: builtins.list[str] [Optional]
The network type 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
Anyhere because we pydantic complains vociferously if we useboto3.session.Session. We exclude it from the model dump because it’s not something that should be serialized.
- manager_class
alias of
DocDBSubnetGroupManager
- 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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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
DBSubnetGroupArnattribute.- Returns:
The ARN of the model instance.
- property name: str | None
Return the name of the model. This is the value of the
DBSubnetGroupNameattribute.- 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
DBSubnetGroupArnattribute.- 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.docdb.DocDBClusterManager[source]
Bases:
Boto3ModelManager- create(model: DocDBCluster, DBClusterParameterGroupName: str | None = None, VpcSecurityGroupIds: list[str] | None = None, DBSubnetGroupName: str | None = None, MasterUserPassword: str | None = None, PreSignedUrl: str | None = None, GlobalClusterIdentifier: str | None = None, ManageMasterUserPassword: bool | None = None, MasterUserSecretKmsKeyId: str | None = None, SourceRegion: str | None = None) DocDBCluster[source]
Creates a new Amazon DocumentDB cluster.
- Parameters:
model – The
DBClusterto create.- Keyword Arguments:
DBClusterParameterGroupName – The name of the cluster parameter group to associate with this cluster.
VpcSecurityGroupIds – A list of EC2 VPC security groups to associate with this cluster.
DBSubnetGroupName – A subnet group to associate with this cluster.
MasterUserPassword – The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (“), or the “at” symbol (@).
PreSignedUrl – Not currently supported.
GlobalClusterIdentifier – The cluster identifier of the new global cluster.
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. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.
SourceRegion – The ID of the region that contains the source for the db cluster.
- delete(DBClusterIdentifier: str, *, SkipFinalSnapshot: bool | None = None, FinalDBSnapshotIdentifier: str | None = None) DocDBCluster[source]
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can’t be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
- Parameters:
DBClusterIdentifier – The cluster identifier for the cluster to be deleted. This parameter isn’t case sensitive.
- Keyword Arguments:
SkipFinalSnapshot – Determines whether a final cluster snapshot is created before the cluster is deleted. If
trueis specified, no cluster snapshot is created. Iffalseis specified, a cluster snapshot is created before the DB cluster is deleted.FinalDBSnapshotIdentifier – The cluster snapshot identifier of the new cluster snapshot created when
SkipFinalSnapshotis set tofalse.
- failover(*, DBClusterIdentifier: str | None = None, TargetDBInstanceIdentifier: str | None = None) DocDBCluster[source]
Forces a failover for a cluster.
- Keyword Arguments:
DBClusterIdentifier – A cluster identifier to force a failover for. This parameter is not case sensitive.
TargetDBInstanceIdentifier – The name of the instance to promote to the primary instance.
- get(*, DBClusterIdentifier: str | None = None) DocDBCluster | None[source]
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdbfilter parameter to return only Amazon DocumentDB clusters.- Keyword Arguments:
DBClusterIdentifier – The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn’t case sensitive.
- list(*, DBClusterIdentifier: str | None = None, Filters: list[botocraft.services.common.Filter] | None = None) PrimaryBoto3ModelQuerySet[source]
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdbfilter parameter to return only Amazon DocumentDB clusters.- Keyword Arguments:
DBClusterIdentifier – The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn’t case sensitive.
Filters – A filter that specifies one or more clusters to describe.
- restore_to_point_in_time(DBClusterIdentifier: str, SourceDBClusterIdentifier: str, *, RestoreType: str | None = None, RestoreToTime: datetime | None = None, UseLatestRestorableTime: bool | None = None, Port: int | None = None, DBSubnetGroupName: str | None = None, VpcSecurityGroupIds: list[str] | None = None, Tags: list[botocraft.services.common.Tag] | None = None, KmsKeyId: str | None = None, EnableCloudwatchLogsExports: list[str] | None = None, DeletionProtection: bool | None = None, ServerlessV2ScalingConfiguration: ServerlessV2ScalingConfiguration | None = None, StorageType: str | None = None, NetworkType: str | None = None) DocDBCluster[source]
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTimefor up toBackupRetentionPerioddays. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.- Parameters:
DBClusterIdentifier – The name of the new cluster to be created.
SourceDBClusterIdentifier – The identifier of the source cluster from which to restore.
- Keyword Arguments:
RestoreType – The type of restore to be performed. You can specify one of the following values:
RestoreToTime – The date and time to restore the cluster to.
UseLatestRestorableTime – A value that is set to
trueto restore the cluster to the latest restorable backup time, andfalseotherwise.Port – The port number on which the new cluster accepts connections.
DBSubnetGroupName – The subnet group name to use for the new cluster.
VpcSecurityGroupIds – A list of VPC security groups that the new cluster belongs to.
Tags – The tags to be assigned to the restored cluster.
KmsKeyId – The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
EnableCloudwatchLogsExports – A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
DeletionProtection – Specifies whether this cluster can be deleted. If
DeletionProtectionis enabled, the cluster cannot be deleted unless it is modified andDeletionProtectionis disabled.DeletionProtectionprotects clusters from being accidentally deleted.ServerlessV2ScalingConfiguration – Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
StorageType – The storage type to associate with the DB cluster.
NetworkType – The network type of the cluster.
- start(DBClusterIdentifier: str) DocDBCluster[source]
Restarts the stopped cluster that is specified by
DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.- Parameters:
DBClusterIdentifier – The identifier of the cluster to restart. Example:
docdb-2019-05-28-15-24-52
- stop(DBClusterIdentifier: str) DocDBCluster[source]
Stops the running cluster that is specified by
DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.- Parameters:
DBClusterIdentifier – The identifier of the cluster to stop. Example:
docdb-2019-05-28-15-24-52
- update(model: DocDBCluster, NewDBClusterIdentifier: str | None = None, ApplyImmediately: bool | None = None, DBClusterParameterGroupName: str | None = None, VpcSecurityGroupIds: list[str] | None = None, MasterUserPassword: str | None = None, CloudwatchLogsExportConfiguration: CloudwatchLogsExportConfiguration | None = None, AllowMajorVersionUpgrade: bool | None = None, ManageMasterUserPassword: bool | None = None, MasterUserSecretKmsKeyId: str | None = None, RotateMasterUserPassword: bool | None = None) DocDBCluster[source]
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
- Parameters:
model – The
DBClusterto update.- Keyword Arguments:
NewDBClusterIdentifier – The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.
ApplyImmediately – A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindowsetting for the cluster. If this parameter is set tofalse, changes to the cluster are applied during the next maintenance window.DBClusterParameterGroupName – The name of the cluster parameter group to use for the cluster.
VpcSecurityGroupIds – A list of virtual private cloud (VPC) security groups that the cluster will belong to.
MasterUserPassword – The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (“), or the “at” symbol (@).
CloudwatchLogsExportConfiguration – The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The
EnableLogTypesandDisableLogTypesarrays determine which logs are exported (or not exported) to CloudWatch Logs.AllowMajorVersionUpgrade – A value that indicates whether major version upgrades are allowed.
ManageMasterUserPassword – Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the cluster doesn’t manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can’t specify
MasterUserPassword. If the cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specifyMasterUserPassword. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified byMasterUserPassword.MasterUserSecretKmsKeyId – The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
RotateMasterUserPassword – Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
- class botocraft.services.docdb.DocDBInstanceManager[source]
Bases:
Boto3ModelManager- create(model: DocDBInstance) DocDBInstance[source]
Creates a new instance.
- Parameters:
model – The
DBInstanceto create.
- delete(DBInstanceIdentifier: str) DocDBInstance[source]
Deletes a previously provisioned instance.
- Parameters:
DBInstanceIdentifier – The instance identifier for the instance to be deleted. This parameter isn’t case sensitive.
- get(DBInstanceIdentifier: str) DocDBInstance | None[source]
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
- Parameters:
DBInstanceIdentifier – The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn’t case sensitive.
- list(*, DBInstanceIdentifier: str | None = None, Filters: list[botocraft.services.common.Filter] | None = None) PrimaryBoto3ModelQuerySet[source]
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
- Keyword Arguments:
DBInstanceIdentifier – The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn’t case sensitive.
Filters – A filter that specifies one or more instances to describe.
- reboot(DBInstanceIdentifier: str, *, ForceFailover: bool | None = None) DocDBInstance[source]
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
- Parameters:
DBInstanceIdentifier – The instance identifier. This parameter is stored as a lowercase string.
- Keyword Arguments:
ForceFailover – When
true, the reboot is conducted through a Multi-AZ failover.
- update(model: DocDBInstance, ApplyImmediately: bool | None = None, NewDBInstanceIdentifier: str | None = None, CertificateRotationRestart: bool | None = None) DocDBInstance[source]
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
- Parameters:
model – The
DBInstanceto update.- Keyword Arguments:
ApplyImmediately – Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindowsetting for the instance.NewDBInstanceIdentifier – The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set
Apply Immediatelytotrue. It occurs during the next maintenance window if you setApply Immediatelytofalse. This value is stored as a lowercase string.CertificateRotationRestart – Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
- class botocraft.services.docdb.DocDBSubnetGroupManager[source]
Bases:
Boto3ModelManager- create(model: DocDBSubnetGroup, SubnetIds: list[str], Tags: list[botocraft.services.common.Tag] | None = None) DocDBSubnetGroup[source]
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
- Parameters:
model – The
DBSubnetGroupto create.SubnetIds – The Amazon EC2 subnet IDs for the subnet group.
- Keyword Arguments:
Tags – The tags to be assigned to the subnet group.
- delete(DBSubnetGroupName: str) None[source]
Deletes a subnet group.
- Parameters:
DBSubnetGroupName – The name of the database subnet group to delete.
- get(DBSubnetGroupName: str) DocDBSubnetGroup | None[source]
Returns a list of
DBSubnetGroupdescriptions. If aDBSubnetGroupNameis specified, the list will contain only the descriptions of the specifiedDBSubnetGroup.- Parameters:
DBSubnetGroupName – The name of the 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
DBSubnetGroupdescriptions. If aDBSubnetGroupNameis specified, the list will contain only the descriptions of the specifiedDBSubnetGroup.- Keyword Arguments:
DBSubnetGroupName – The name of the subnet group to return details for.
Filters – This parameter is not currently supported.
- update(model: DocDBSubnetGroup, SubnetIds: list[str]) DocDBSubnetGroup[source]
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
- Parameters:
model – The
DBSubnetGroupto update.SubnetIds – The Amazon EC2 subnet IDs for the subnet group.
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.docdb.ClusterMasterUserSecret[source]
Bases:
Boto3ModelContains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
Show JSON schema
{ "title": "ClusterMasterUserSecret", "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DBClusterMember[source]
Bases:
Boto3ModelContains information about an instance that is part of a cluster.
Show JSON schema
{ "title": "DBClusterMember", "description": "Contains information about an instance that is part of a cluster.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field DBClusterParameterGroupStatus: str | None = None
Specifies the status of the cluster parameter group for this member of the DB cluster.
- field DBInstanceIdentifier: str | None = None
Specifies the instance identifier for this member of the cluster.
- field IsClusterWriter: bool | None = None
A value that is
trueif the cluster member is the primary instance for the cluster andfalseotherwise.
- field PromotionTier: int | None = None
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DBClusterRole[source]
Bases:
Boto3ModelDescribes an Identity and Access Management (IAM) role that is associated with a cluster.
Show JSON schema
{ "title": "DBClusterRole", "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field RoleArn: str | None = None
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
- field Status: str | None = None
Describes the state of association between the IAMrole and the cluster.
The
Statusproperty 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DBInstanceStatusInfo[source]
Bases:
Boto3ModelProvides a list of status information for an instance.
Show JSON schema
{ "title": "DBInstanceStatusInfo", "description": "Provides a list of status information for an instance.", "type": "object", "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" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field Message: str | None = None
Details of the error if there is an error for the instance.
If the instance is not in an error state, this value is blank.
- field Normal: bool | None = None
A Boolean value that is
trueif the instance is operating normally, orfalseif the instance is in an error state.
- field Status: str | None = None
Status of the instance.
For a
StatusTypeof read replica, the values can bereplicating, error,stopped, orterminated.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBCertificateDetails[source]
Bases:
Boto3ModelReturns the details of the DB instance’s server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
Show JSON schema
{ "title": "DocDBCertificateDetails", "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBEndpoint[source]
Bases:
Boto3ModelNetwork information for accessing a cluster or instance.
Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.
Show JSON schema
{ "title": "DocDBEndpoint", "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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 HostedZoneId: str | None = None
Specifies the ID that Amazon Route 53 assigns when you create a hosted 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBPendingCloudwatchLogsExports[source]
Bases:
Boto3ModelA list of the log types whose configuration is still pending.
These log types are in the process of being activated or deactivated.
Show JSON schema
{ "title": "DocDBPendingCloudwatchLogsExports", "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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 Amazon 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBPendingModifiedValues[source]
Bases:
Boto3ModelOne or more modified settings for an instance.
These modified settings have been requested, but haven’t been applied yet.
Show JSON schema
{ "title": "DocDBPendingModifiedValues", "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "$defs": { "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field AllocatedStorage: int | None = None
Contains the new
AllocatedStoragesize for then instance that will be applied or is currently being applied.
- field BackupRetentionPeriod: int | None = None
Specifies the pending number of days for which automated backups are retained.
- field CACertificateIdentifier: str | None = None
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
- field DBInstanceClass: str | None = None
Contains the new
DBInstanceClassfor the instance that will be applied or is currently being applied.
- field DBInstanceIdentifier: str | None = None
Contains the new
DBInstanceIdentifierfor the instance that will be applied or is currently being applied.
- field Iops: int | None = None
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
- field MasterUserPassword: str | None = None
Contains the pending or currently in-progress change of the master credentials for the instance.
- field MultiAZ: bool | None = None
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
- field PendingCloudwatchLogsExports: DocDBPendingCloudwatchLogsExports | None = None
A list of the log types whose configuration is still pending.
These log types are in the process of being activated or deactivated.
- field StorageType: str | None = None
Specifies the storage type to be associated with the 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.ServerlessV2ScalingConfigurationInfo[source]
Bases:
Boto3ModelRetrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.
Show JSON schema
{ "title": "ServerlessV2ScalingConfigurationInfo", "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field MaxCapacity: float | None = None
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
- field MinCapacity: float | None = None
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
You can specify DCU values in half-step increments, such as 8, 8.5, 9, 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.VpcSecurityGroupMembership[source]
Bases:
Boto3ModelUsed as a response element for queries on virtual private cloud (VPC) security group membership.
Show JSON schema
{ "title": "VpcSecurityGroupMembership", "description": "Used as a response element for queries on virtual private cloud (VPC) security group\nmembership.", "type": "object", "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" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.CloudwatchLogsExportConfiguration[source]
Bases:
Boto3ModelThe configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.
The
EnableLogTypesandDisableLogTypesarrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.Show JSON schema
{ "title": "CloudwatchLogsExportConfiguration", "description": "The configuration setting for the log types to be enabled for export to Amazon\nCloudWatch Logs for a specific instance or cluster.\n\nThe ``EnableLogTypes`` and ``DisableLogTypes`` arrays determine which logs are exported (or not exported) to CloudWatch\nLogs. The values within these arrays depend on the engine that is being used.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "EnableLogTypes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Enablelogtypes" }, "DisableLogTypes": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Disablelogtypes" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.CreateDBClusterResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "CreateDBClusterResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DeleteDBClusterResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "DeleteDBClusterResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBClusterMessage[source]
Bases:
Boto3ModelRepresents the output of DescribeDBClusters.
Show JSON schema
{ "title": "DocDBClusterMessage", "description": "Represents the output of DescribeDBClusters.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "Marker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Marker" }, "DBClusters": { "anyOf": [ { "items": { "$ref": "#/$defs/DocDBCluster" }, "type": "array" }, { "type": "null" } ], "title": "Dbclusters" } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBClusters: builtins.list[DocDBCluster] | None [Optional]
A list of clusters.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBCreateDBInstanceResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "DocDBCreateDBInstanceResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstance": { "anyOf": [ { "$ref": "#/$defs/DocDBInstance" }, { "type": "null" } ], "default": null } }, "$defs": { "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" }, "DocDBCertificateDetails": { "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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": "DocDBCertificateDetails", "type": "object" }, "DocDBEndpoint": { "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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": "DocDBEndpoint", "type": "object" }, "DocDBInstance": { "description": "Detailed information about an instance.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "DBInstanceClass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceclass" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "DBInstanceStatus": { "default": null, "title": "Dbinstancestatus", "type": "string" }, "Endpoint": { "$ref": "#/$defs/DocDBEndpoint", "default": null }, "InstanceCreateTime": { "default": null, "format": "date-time", "title": "Instancecreatetime", "type": "string" }, "PreferredBackupWindow": { "default": null, "title": "Preferredbackupwindow", "type": "string" }, "BackupRetentionPeriod": { "default": null, "title": "Backupretentionperiod", "type": "integer" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "AvailabilityZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzone" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "PendingModifiedValues": { "$ref": "#/$defs/DocDBPendingModifiedValues", "default": null }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "EngineVersion": { "default": null, "title": "Engineversion", "type": "string" }, "AutoMinorVersionUpgrade": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Autominorversionupgrade" }, "PubliclyAccessible": { "default": null, "title": "Publiclyaccessible", "type": "boolean" }, "StatusInfos": { "items": { "$ref": "#/$defs/DBInstanceStatusInfo" }, "title": "Statusinfos", "type": "array" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "StorageEncrypted": { "default": null, "title": "Storageencrypted", "type": "boolean" }, "KmsKeyId": { "default": null, "title": "Kmskeyid", "type": "string" }, "DbiResourceId": { "default": null, "title": "Dbiresourceid", "type": "string" }, "CACertificateIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cacertificateidentifier" }, "CopyTagsToSnapshot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Copytagstosnapshot" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" }, "DBInstanceArn": { "default": null, "title": "Dbinstancearn", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "CertificateDetails": { "$ref": "#/$defs/DocDBCertificateDetails", "default": null }, "PerformanceInsightsEnabled": { "default": null, "title": "Performanceinsightsenabled", "type": "boolean" }, "PerformanceInsightsKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Performanceinsightskmskeyid" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBInstance", "type": "object" }, "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" }, "DocDBPendingModifiedValues": { "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "title": "DocDBPendingModifiedValues", "type": "object" }, "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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 DBInstance: DocDBInstance | None = None
Detailed information about an 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBCreateDBSubnetGroupResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "DocDBCreateDBSubnetGroupResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null } }, "$defs": { "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field DBSubnetGroup: DocDBSubnetGroup | None = None
Detailed information about a 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBDeleteDBInstanceResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "DocDBDeleteDBInstanceResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstance": { "anyOf": [ { "$ref": "#/$defs/DocDBInstance" }, { "type": "null" } ], "default": null } }, "$defs": { "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" }, "DocDBCertificateDetails": { "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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": "DocDBCertificateDetails", "type": "object" }, "DocDBEndpoint": { "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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": "DocDBEndpoint", "type": "object" }, "DocDBInstance": { "description": "Detailed information about an instance.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "DBInstanceClass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceclass" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "DBInstanceStatus": { "default": null, "title": "Dbinstancestatus", "type": "string" }, "Endpoint": { "$ref": "#/$defs/DocDBEndpoint", "default": null }, "InstanceCreateTime": { "default": null, "format": "date-time", "title": "Instancecreatetime", "type": "string" }, "PreferredBackupWindow": { "default": null, "title": "Preferredbackupwindow", "type": "string" }, "BackupRetentionPeriod": { "default": null, "title": "Backupretentionperiod", "type": "integer" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "AvailabilityZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzone" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "PendingModifiedValues": { "$ref": "#/$defs/DocDBPendingModifiedValues", "default": null }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "EngineVersion": { "default": null, "title": "Engineversion", "type": "string" }, "AutoMinorVersionUpgrade": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Autominorversionupgrade" }, "PubliclyAccessible": { "default": null, "title": "Publiclyaccessible", "type": "boolean" }, "StatusInfos": { "items": { "$ref": "#/$defs/DBInstanceStatusInfo" }, "title": "Statusinfos", "type": "array" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "StorageEncrypted": { "default": null, "title": "Storageencrypted", "type": "boolean" }, "KmsKeyId": { "default": null, "title": "Kmskeyid", "type": "string" }, "DbiResourceId": { "default": null, "title": "Dbiresourceid", "type": "string" }, "CACertificateIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cacertificateidentifier" }, "CopyTagsToSnapshot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Copytagstosnapshot" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" }, "DBInstanceArn": { "default": null, "title": "Dbinstancearn", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "CertificateDetails": { "$ref": "#/$defs/DocDBCertificateDetails", "default": null }, "PerformanceInsightsEnabled": { "default": null, "title": "Performanceinsightsenabled", "type": "boolean" }, "PerformanceInsightsKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Performanceinsightskmskeyid" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBInstance", "type": "object" }, "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" }, "DocDBPendingModifiedValues": { "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "title": "DocDBPendingModifiedValues", "type": "object" }, "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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 DBInstance: DocDBInstance | None = None
Detailed information about an 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBInstanceMessage[source]
Bases:
Boto3ModelRepresents the output of DescribeDBInstances.
Show JSON schema
{ "title": "DocDBInstanceMessage", "description": "Represents the output of DescribeDBInstances.", "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/DocDBInstance" }, "type": "array" }, { "type": "null" } ], "title": "Dbinstances" } }, "$defs": { "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" }, "DocDBCertificateDetails": { "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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": "DocDBCertificateDetails", "type": "object" }, "DocDBEndpoint": { "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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": "DocDBEndpoint", "type": "object" }, "DocDBInstance": { "description": "Detailed information about an instance.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "DBInstanceClass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceclass" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "DBInstanceStatus": { "default": null, "title": "Dbinstancestatus", "type": "string" }, "Endpoint": { "$ref": "#/$defs/DocDBEndpoint", "default": null }, "InstanceCreateTime": { "default": null, "format": "date-time", "title": "Instancecreatetime", "type": "string" }, "PreferredBackupWindow": { "default": null, "title": "Preferredbackupwindow", "type": "string" }, "BackupRetentionPeriod": { "default": null, "title": "Backupretentionperiod", "type": "integer" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "AvailabilityZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzone" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "PendingModifiedValues": { "$ref": "#/$defs/DocDBPendingModifiedValues", "default": null }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "EngineVersion": { "default": null, "title": "Engineversion", "type": "string" }, "AutoMinorVersionUpgrade": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Autominorversionupgrade" }, "PubliclyAccessible": { "default": null, "title": "Publiclyaccessible", "type": "boolean" }, "StatusInfos": { "items": { "$ref": "#/$defs/DBInstanceStatusInfo" }, "title": "Statusinfos", "type": "array" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "StorageEncrypted": { "default": null, "title": "Storageencrypted", "type": "boolean" }, "KmsKeyId": { "default": null, "title": "Kmskeyid", "type": "string" }, "DbiResourceId": { "default": null, "title": "Dbiresourceid", "type": "string" }, "CACertificateIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cacertificateidentifier" }, "CopyTagsToSnapshot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Copytagstosnapshot" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" }, "DBInstanceArn": { "default": null, "title": "Dbinstancearn", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "CertificateDetails": { "$ref": "#/$defs/DocDBCertificateDetails", "default": null }, "PerformanceInsightsEnabled": { "default": null, "title": "Performanceinsightsenabled", "type": "boolean" }, "PerformanceInsightsKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Performanceinsightskmskeyid" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBInstance", "type": "object" }, "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" }, "DocDBPendingModifiedValues": { "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "title": "DocDBPendingModifiedValues", "type": "object" }, "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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[DocDBInstance] | None [Optional]
Detailed information about one or more 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBModifyDBInstanceResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "DocDBModifyDBInstanceResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstance": { "anyOf": [ { "$ref": "#/$defs/DocDBInstance" }, { "type": "null" } ], "default": null } }, "$defs": { "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" }, "DocDBCertificateDetails": { "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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": "DocDBCertificateDetails", "type": "object" }, "DocDBEndpoint": { "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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": "DocDBEndpoint", "type": "object" }, "DocDBInstance": { "description": "Detailed information about an instance.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "DBInstanceClass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceclass" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "DBInstanceStatus": { "default": null, "title": "Dbinstancestatus", "type": "string" }, "Endpoint": { "$ref": "#/$defs/DocDBEndpoint", "default": null }, "InstanceCreateTime": { "default": null, "format": "date-time", "title": "Instancecreatetime", "type": "string" }, "PreferredBackupWindow": { "default": null, "title": "Preferredbackupwindow", "type": "string" }, "BackupRetentionPeriod": { "default": null, "title": "Backupretentionperiod", "type": "integer" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "AvailabilityZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzone" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "PendingModifiedValues": { "$ref": "#/$defs/DocDBPendingModifiedValues", "default": null }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "EngineVersion": { "default": null, "title": "Engineversion", "type": "string" }, "AutoMinorVersionUpgrade": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Autominorversionupgrade" }, "PubliclyAccessible": { "default": null, "title": "Publiclyaccessible", "type": "boolean" }, "StatusInfos": { "items": { "$ref": "#/$defs/DBInstanceStatusInfo" }, "title": "Statusinfos", "type": "array" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "StorageEncrypted": { "default": null, "title": "Storageencrypted", "type": "boolean" }, "KmsKeyId": { "default": null, "title": "Kmskeyid", "type": "string" }, "DbiResourceId": { "default": null, "title": "Dbiresourceid", "type": "string" }, "CACertificateIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cacertificateidentifier" }, "CopyTagsToSnapshot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Copytagstosnapshot" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" }, "DBInstanceArn": { "default": null, "title": "Dbinstancearn", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "CertificateDetails": { "$ref": "#/$defs/DocDBCertificateDetails", "default": null }, "PerformanceInsightsEnabled": { "default": null, "title": "Performanceinsightsenabled", "type": "boolean" }, "PerformanceInsightsKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Performanceinsightskmskeyid" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBInstance", "type": "object" }, "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" }, "DocDBPendingModifiedValues": { "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "title": "DocDBPendingModifiedValues", "type": "object" }, "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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 DBInstance: DocDBInstance | None = None
Detailed information about an 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBModifyDBSubnetGroupResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "DocDBModifyDBSubnetGroupResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null } }, "$defs": { "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field DBSubnetGroup: DocDBSubnetGroup | None = None
Detailed information about a 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.DocDBSubnetGroupMessage[source]
Bases:
Boto3ModelRepresents the output of DescribeDBSubnetGroups.
Show JSON schema
{ "title": "DocDBSubnetGroupMessage", "description": "Represents the output of DescribeDBSubnetGroups.", "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/DocDBSubnetGroup" }, "type": "array" }, { "type": "null" } ], "title": "Dbsubnetgroups" } }, "$defs": { "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field DBSubnetGroups: builtins.list[DocDBSubnetGroup] | None [Optional]
Detailed information about one or more subnet groups.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.FailoverDBClusterResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "FailoverDBClusterResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.ModifyDBClusterResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "ModifyDBClusterResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.RebootDBInstanceResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "RebootDBInstanceResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstance": { "anyOf": [ { "$ref": "#/$defs/DocDBInstance" }, { "type": "null" } ], "default": null } }, "$defs": { "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" }, "DocDBCertificateDetails": { "description": "Returns the details of the DB instance\u2019s server certificate.\n\nFor more information, see\n`Updating Your Amazon DocumentDB TLS Certificates <https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html>`_\nand\n`Encrypting Data in Transit <https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html>`_\nin the *Amazon\nDocumentDB Developer Guide*.", "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": "DocDBCertificateDetails", "type": "object" }, "DocDBEndpoint": { "description": "Network information for accessing a cluster or instance.\n\nClient programs must specify a valid endpoint to access these Amazon DocumentDB\nresources.", "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": "DocDBEndpoint", "type": "object" }, "DocDBInstance": { "description": "Detailed information about an instance.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "$ref": "#/$defs/DocDBSubnetGroup" }, { "type": "null" } ], "default": null }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "DBInstanceClass": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceclass" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "DBInstanceStatus": { "default": null, "title": "Dbinstancestatus", "type": "string" }, "Endpoint": { "$ref": "#/$defs/DocDBEndpoint", "default": null }, "InstanceCreateTime": { "default": null, "format": "date-time", "title": "Instancecreatetime", "type": "string" }, "PreferredBackupWindow": { "default": null, "title": "Preferredbackupwindow", "type": "string" }, "BackupRetentionPeriod": { "default": null, "title": "Backupretentionperiod", "type": "integer" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "AvailabilityZone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzone" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "PendingModifiedValues": { "$ref": "#/$defs/DocDBPendingModifiedValues", "default": null }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "EngineVersion": { "default": null, "title": "Engineversion", "type": "string" }, "AutoMinorVersionUpgrade": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Autominorversionupgrade" }, "PubliclyAccessible": { "default": null, "title": "Publiclyaccessible", "type": "boolean" }, "StatusInfos": { "items": { "$ref": "#/$defs/DBInstanceStatusInfo" }, "title": "Statusinfos", "type": "array" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "StorageEncrypted": { "default": null, "title": "Storageencrypted", "type": "boolean" }, "KmsKeyId": { "default": null, "title": "Kmskeyid", "type": "string" }, "DbiResourceId": { "default": null, "title": "Dbiresourceid", "type": "string" }, "CACertificateIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Cacertificateidentifier" }, "CopyTagsToSnapshot": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Copytagstosnapshot" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" }, "DBInstanceArn": { "default": null, "title": "Dbinstancearn", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "CertificateDetails": { "$ref": "#/$defs/DocDBCertificateDetails", "default": null }, "PerformanceInsightsEnabled": { "default": null, "title": "Performanceinsightsenabled", "type": "boolean" }, "PerformanceInsightsKMSKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Performanceinsightskmskeyid" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBInstance", "type": "object" }, "DocDBPendingCloudwatchLogsExports": { "description": "A list of the log types whose configuration is still pending.\n\nThese log types are in the process of being activated or deactivated.", "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": "DocDBPendingCloudwatchLogsExports", "type": "object" }, "DocDBPendingModifiedValues": { "description": "One or more modified settings for an instance.\n\nThese modified settings have been requested, but haven't been applied yet.", "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" }, "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/DocDBPendingCloudwatchLogsExports" }, { "type": "null" } ], "default": null } }, "title": "DocDBPendingModifiedValues", "type": "object" }, "DocDBSubnetGroup": { "description": "Detailed information about a subnet group.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroupName": { "title": "Dbsubnetgroupname", "type": "string" }, "DBSubnetGroupDescription": { "title": "Dbsubnetgroupdescription", "type": "string" }, "Subnets": { "items": { "$ref": "#/$defs/Subnet" }, "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": "DocDBSubnetGroup", "type": "object" }, "EC2BlockPublicAccessStates": { "description": "The state of VPC Block Public Access (BPA).", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "InternetGatewayBlockMode": { "anyOf": [ { "enum": [ "off", "block-bidirectional", "block-ingress" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Internetgatewayblockmode" } }, "title": "EC2BlockPublicAccessStates", "type": "object" }, "EC2PrivateDnsNameOptionsOnLaunch": { "description": "Describes the options for instance hostnames.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "HostnameType": { "anyOf": [ { "enum": [ "ip-name", "resource-name" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Hostnametype" }, "EnableResourceNameDnsARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsarecord" }, "EnableResourceNameDnsAAAARecord": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Enableresourcenamednsaaaarecord" } }, "title": "EC2PrivateDnsNameOptionsOnLaunch", "type": "object" }, "Subnet": { "description": "Describes a subnet.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "VpcId": { "title": "Vpcid", "type": "string" }, "AvailabilityZone": { "title": "Availabilityzone", "type": "string" }, "CidrBlock": { "title": "Cidrblock", "type": "string" }, "Ipv6Native": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false, "title": "Ipv6Native" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" }, "AvailabilityZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Availabilityzoneid" }, "EnableLniAtDeviceIndex": { "default": null, "title": "Enablelniatdeviceindex", "type": "integer" }, "MapCustomerOwnedIpOnLaunch": { "default": null, "title": "Mapcustomerownediponlaunch", "type": "boolean" }, "CustomerOwnedIpv4Pool": { "default": null, "title": "Customerownedipv4Pool", "type": "string" }, "OwnerId": { "default": null, "title": "Ownerid", "type": "string" }, "AssignIpv6AddressOnCreation": { "default": null, "title": "Assignipv6Addressoncreation", "type": "boolean" }, "Ipv6CidrBlockAssociationSet": { "items": { "$ref": "#/$defs/SubnetIpv6CidrBlockAssociation" }, "title": "Ipv6Cidrblockassociationset", "type": "array" }, "SubnetArn": { "default": null, "title": "Subnetarn", "type": "string" }, "OutpostArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Outpostarn" }, "EnableDns64": { "default": null, "title": "Enabledns64", "type": "boolean" }, "PrivateDnsNameOptionsOnLaunch": { "$ref": "#/$defs/EC2PrivateDnsNameOptionsOnLaunch", "default": null }, "BlockPublicAccessStates": { "$ref": "#/$defs/EC2BlockPublicAccessStates", "default": null }, "Type": { "default": null, "title": "Type", "type": "string" }, "SubnetId": { "default": null, "title": "Subnetid", "type": "string" }, "State": { "default": null, "enum": [ "pending", "available", "unavailable", "failed", "failed-insufficient-capacity" ], "title": "State", "type": "string" }, "AvailableIpAddressCount": { "default": null, "title": "Availableipaddresscount", "type": "integer" }, "DefaultForAz": { "default": null, "title": "Defaultforaz", "type": "boolean" }, "MapPublicIpOnLaunch": { "default": null, "title": "Mappubliciponlaunch", "type": "boolean" } }, "required": [ "VpcId", "AvailabilityZone", "CidrBlock" ], "title": "Subnet", "type": "object" }, "SubnetCidrBlockState": { "description": "Describes the state of a CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "State": { "anyOf": [ { "enum": [ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "State" }, "StatusMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Statusmessage" } }, "title": "SubnetCidrBlockState", "type": "object" }, "SubnetIpv6CidrBlockAssociation": { "description": "Describes an association between a subnet and an IPv6 CIDR block.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "AssociationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Associationid" }, "Ipv6CidrBlock": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Cidrblock" }, "Ipv6CidrBlockState": { "anyOf": [ { "$ref": "#/$defs/SubnetCidrBlockState" }, { "type": "null" } ], "default": null }, "Ipv6AddressAttribute": { "anyOf": [ { "enum": [ "public", "private" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipv6Addressattribute" }, "IpSource": { "anyOf": [ { "enum": [ "amazon", "byoip", "none" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Ipsource" } }, "title": "SubnetIpv6CidrBlockAssociation", "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 DBInstance: DocDBInstance | None = None
Detailed information about an 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.RestoreDBClusterToPointInTimeResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "RestoreDBClusterToPointInTimeResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.ServerlessV2ScalingConfiguration[source]
Bases:
Boto3ModelSets the scaling configuration of an Amazon DocumentDB Serverless cluster.
Show JSON schema
{ "title": "ServerlessV2ScalingConfiguration", "description": "Sets the scaling configuration of an Amazon DocumentDB Serverless cluster.", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } } }
- Config:
validate_assignment: bool = True
arbitrary_types_allowed: bool = True
- Fields:
- field MaxCapacity: float | None = None
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
- field MinCapacity: float | None = None
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster.
You can specify DCU values in half-step increments, such as 8, 8.5, 9, 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.StartDBClusterResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "StartDBClusterResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.docdb.StopDBClusterResult[source]
Bases:
Boto3ModelShow JSON schema
{ "title": "StopDBClusterResult", "type": "object", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBCluster": { "anyOf": [ { "$ref": "#/$defs/DocDBCluster" }, { "type": "null" } ], "default": null } }, "$defs": { "ClusterMasterUserSecret": { "description": "Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets\nManager for the master user password.", "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": "ClusterMasterUserSecret", "type": "object" }, "DBClusterMember": { "description": "Contains information about an instance that is part of a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBInstanceIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbinstanceidentifier" }, "IsClusterWriter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Isclusterwriter" }, "DBClusterParameterGroupStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusterparametergroupstatus" }, "PromotionTier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Promotiontier" } }, "title": "DBClusterMember", "type": "object" }, "DBClusterRole": { "description": "Describes an Identity and Access Management (IAM) role that is associated with a\ncluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "RoleArn": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Rolearn" }, "Status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Status" } }, "title": "DBClusterRole", "type": "object" }, "DocDBCluster": { "description": "Detailed information about a cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "DBSubnetGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbsubnetgroup" }, "AvailabilityZones": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Availabilityzones" }, "BackupRetentionPeriod": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Backupretentionperiod" }, "DBClusterIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Dbclusteridentifier" }, "DBClusterParameterGroup": { "default": null, "title": "Dbclusterparametergroup", "type": "string" }, "Status": { "default": null, "title": "Status", "type": "string" }, "PercentProgress": { "default": null, "title": "Percentprogress", "type": "string" }, "EarliestRestorableTime": { "default": null, "format": "date-time", "title": "Earliestrestorabletime", "type": "string" }, "Endpoint": { "default": null, "title": "Endpoint", "type": "string" }, "ReaderEndpoint": { "default": null, "title": "Readerendpoint", "type": "string" }, "MultiAZ": { "default": null, "title": "Multiaz", "type": "boolean" }, "Engine": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engine" }, "EngineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Engineversion" }, "LatestRestorableTime": { "default": null, "format": "date-time", "title": "Latestrestorabletime", "type": "string" }, "Port": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "title": "Port" }, "MasterUsername": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Masterusername" }, "PreferredBackupWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredbackupwindow" }, "PreferredMaintenanceWindow": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Preferredmaintenancewindow" }, "ReplicationSourceIdentifier": { "default": null, "title": "Replicationsourceidentifier", "type": "string" }, "ReadReplicaIdentifiers": { "items": { "type": "string" }, "title": "Readreplicaidentifiers", "type": "array" }, "DBClusterMembers": { "items": { "$ref": "#/$defs/DBClusterMember" }, "title": "Dbclustermembers", "type": "array" }, "VpcSecurityGroups": { "items": { "$ref": "#/$defs/VpcSecurityGroupMembership" }, "title": "Vpcsecuritygroups", "type": "array" }, "HostedZoneId": { "default": null, "title": "Hostedzoneid", "type": "string" }, "StorageEncrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Storageencrypted" }, "KmsKeyId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Kmskeyid" }, "DbClusterResourceId": { "default": null, "title": "Dbclusterresourceid", "type": "string" }, "DBClusterArn": { "default": null, "title": "Dbclusterarn", "type": "string" }, "AssociatedRoles": { "items": { "$ref": "#/$defs/DBClusterRole" }, "title": "Associatedroles", "type": "array" }, "CloneGroupId": { "default": null, "title": "Clonegroupid", "type": "string" }, "ClusterCreateTime": { "default": null, "format": "date-time", "title": "Clustercreatetime", "type": "string" }, "EnabledCloudwatchLogsExports": { "items": { "type": "string" }, "title": "Enabledcloudwatchlogsexports", "type": "array" }, "DeletionProtection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "title": "Deletionprotection" }, "IOOptimizedNextAllowedModificationTime": { "default": null, "format": "date-time", "title": "Iooptimizednextallowedmodificationtime", "type": "string" }, "StorageType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Storagetype" }, "ServerlessV2ScalingConfiguration": { "anyOf": [ { "$ref": "#/$defs/ServerlessV2ScalingConfigurationInfo" }, { "type": "null" } ], "default": null }, "MasterUserSecret": { "$ref": "#/$defs/ClusterMasterUserSecret", "default": null }, "NetworkType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Networktype" }, "Tags": { "anyOf": [ { "items": { "$ref": "#/$defs/Tag" }, "type": "array" }, { "type": "null" } ], "title": "Tags" } }, "title": "DocDBCluster", "type": "object" }, "ServerlessV2ScalingConfigurationInfo": { "description": "Retrieves the scaling configuration for an Amazon DocumentDB Serverless cluster.", "properties": { "session": { "anyOf": [ {}, { "type": "null" } ], "default": null, "title": "Session" }, "MinCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Mincapacity" }, "MaxCapacity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "title": "Maxcapacity" } }, "title": "ServerlessV2ScalingConfigurationInfo", "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 DBCluster: DocDBCluster | None = None
Detailed information about a cluster.
- 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
Anyhere because we pydantic complains vociferously if we useboto3.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.
transformeris 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
transformerisNone, the attribute will be returned verbatim.If
transformerhas no named groups, the attribute will be replaced with the value of the first group.If
transformerhas 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.