Expand description
Data structures used by operation inputs/outputs.
Modules§
- builders
- Builders
- error
- Error types that Amazon DocumentDB with MongoDB compatibility can respond with.
Structs§
- Availability
Zone Information about an Availability Zone.
- Certificate
A certificate authority (CA) certificate for an Amazon Web Services account.
- Certificate
Details Returns 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.
- Cloudwatch
Logs Export Configuration The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.
The
EnableLogTypes
andDisableLogTypes
arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.- Cluster
Master User Secret Contains the secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
- DbCluster
Detailed information about a cluster.
- DbCluster
Member Contains information about an instance that is part of a cluster.
- DbCluster
Parameter Group Detailed information about a cluster parameter group.
- DbCluster
Role Describes an Identity and Access Management (IAM) role that is associated with a cluster.
- DbCluster
Snapshot Detailed information about a cluster snapshot.
- DbCluster
Snapshot Attribute Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.
- DbCluster
Snapshot Attributes Result Detailed information about the attributes that are associated with a cluster snapshot.
- DbEngine
Version Detailed information about an engine version.
- DbInstance
Detailed information about an instance.
- DbInstance
Status Info Provides a list of status information for an instance.
- DbSubnet
Group Detailed information about a subnet group.
- Endpoint
Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.
- Engine
Defaults Contains the result of a successful invocation of the
DescribeEngineDefaultClusterParameters
operation.- Event
Detailed information about an event.
- Event
Categories Map An event source type, accompanied by one or more event category names.
- Event
Subscription Detailed information about an event to which you have subscribed.
- Filter
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
- Global
Cluster A data type representing an Amazon DocumentDB global cluster.
- Global
Cluster Member A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
- Orderable
DbInstance Option The options that are available for an instance.
- Parameter
Detailed information about an individual parameter.
- Pending
Cloudwatch Logs Exports A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
- Pending
Maintenance Action Provides information about a pending maintenance action for a resource.
- Pending
Modified Values One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.
- Resource
Pending Maintenance Actions Represents the output of
ApplyPendingMaintenanceAction
.- Subnet
Detailed information about a subnet.
- Tag
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
- Upgrade
Target The version of the database engine that an instance can be upgraded to.
- VpcSecurity
Group Membership Used as a response element for queries on virtual private cloud (VPC) security group membership.
Enums§
- Apply
Method - When writing a match expression against
ApplyMethod
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Source
Type - When writing a match expression against
SourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.