Module types

Source
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§

AvailabilityZone

Information about an Availability Zone.

Certificate

A certificate authority (CA) certificate for an Amazon Web Services account.

CertificateDetails

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.

CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.

The EnableLogTypes and DisableLogTypes 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.

ClusterMasterUserSecret

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

DbCluster

Detailed information about a cluster.

DbClusterMember

Contains information about an instance that is part of a cluster.

DbClusterParameterGroup

Detailed information about a cluster parameter group.

DbClusterRole

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

DbClusterSnapshot

Detailed information about a cluster snapshot.

DbClusterSnapshotAttribute

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.

DbClusterSnapshotAttributesResult

Detailed information about the attributes that are associated with a cluster snapshot.

DbEngineVersion

Detailed information about an engine version.

DbInstance

Detailed information about an instance.

DbInstanceStatusInfo

Provides a list of status information for an instance.

DbSubnetGroup

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.

EngineDefaults

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

Event

Detailed information about an event.

EventCategoriesMap

An event source type, accompanied by one or more event category names.

EventSubscription

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.

GlobalCluster

A data type representing an Amazon DocumentDB global cluster.

GlobalClusterMember

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

OrderableDbInstanceOption

The options that are available for an instance.

Parameter

Detailed information about an individual parameter.

PendingCloudwatchLogsExports

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

PendingMaintenanceAction

Provides information about a pending maintenance action for a resource.

PendingModifiedValues

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

ResourcePendingMaintenanceActions

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.

UpgradeTarget

The version of the database engine that an instance can be upgraded to.

VpcSecurityGroupMembership

Used as a response element for queries on virtual private cloud (VPC) security group membership.

Enums§

ApplyMethod
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.
SourceType
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.