Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Account
Quota Describes a quota for an Amazon Web Services account.
The following are account quotas:
-
AllocatedStorage
- The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB. -
AuthorizationsPerDBSecurityGroup
- The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules. -
CustomEndpointsPerDBCluster
- The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints. -
DBClusterParameterGroups
- The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account. -
DBClusterRoles
- The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles. -
DBClusters
- The number of DB clusters per account. The used value is the count of DB clusters in the account. -
DBInstanceRoles
- The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles. -
DBInstances
- The number of DB instances per account. The used value is the count of the DB instances in the account.Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.
-
DBParameterGroups
- The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account. -
DBSecurityGroups
- The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account. -
DBSubnetGroups
- The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account. -
EventSubscriptions
- The number of event subscriptions per account. The used value is the count of the event subscriptions in the account. -
ManualClusterSnapshots
- The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account. -
ManualSnapshots
- The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account. -
OptionGroups
- The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account. -
ReadReplicasPerMaster
- The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas. -
ReservedDBInstances
- The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account. -
SubnetsPerDBSubnetGroup
- The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.
For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide.
-
- Availability
Zone Contains Availability Zone information.
This data type is used as an element in the
OrderableDBInstanceOption
data type.- Available
Processor Feature Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
- Blue
Green Deployment Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Blue
Green Deployment Task Details about a task for a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Certificate
A CA certificate for an Amazon Web Services account.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Certificate
Details The details of the DB instance’s server certificate.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
- Character
Set This data type is used as a response element in the action
DescribeDBEngineVersions
.- Cloudwatch
Logs Export Configuration The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.
The
EnableLogTypes
andDisableLogTypes
arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used.For more information about exporting CloudWatch Logs for Amazon RDS DB instances, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
For more information about exporting CloudWatch Logs for Amazon Aurora DB clusters, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
- Cluster
Pending Modified Values This data type is used as a response element in the
ModifyDBCluster
operation and contains changes that will be applied during the next maintenance window.- Connection
Pool Configuration Specifies the settings that control the size and behavior of the connection pool associated with a
DBProxyTargetGroup
.- Connection
Pool Configuration Info Displays the settings that control the size and behavior of the connection pool associated with a
DBProxyTarget
.- Context
Attribute The additional attributes of
RecommendedAction
data type.- Custom
DbEngine Version Ami A value that indicates the AMI information.
- DbCluster
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,PromoteReadReplicaDBCluster
,RestoreDBClusterFromS3
,RestoreDBClusterFromSnapshot
,RestoreDBClusterToPointInTime
,StartDBCluster
, andStopDBCluster
.For a Multi-AZ DB cluster, this data type is used as a response element in the operations
CreateDBCluster
,DeleteDBCluster
,DescribeDBClusters
,FailoverDBCluster
,ModifyDBCluster
,RebootDBCluster
,RestoreDBClusterFromSnapshot
, andRestoreDBClusterToPointInTime
.For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
- DbCluster
Automated Backup An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster.
- DbCluster
Backtrack This data type is used as a response element in the
DescribeDBClusterBacktracks
action.- DbCluster
Endpoint This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
-
CreateDBClusterEndpoint
-
DescribeDBClusterEndpoints
-
ModifyDBClusterEndpoint
-
DeleteDBClusterEndpoint
For the data structure that represents Amazon RDS DB instance endpoints, see
Endpoint
.-
- DbCluster
Member Contains information about an instance that is part of a DB cluster.
- DbCluster
Option Group Status Contains status information for a DB cluster option group.
- DbCluster
Parameter Group Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the
DescribeDBClusterParameterGroups
action.- DbCluster
Role Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
- DbCluster
Snapshot Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots
action.- DbCluster
Snapshot Attribute Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.- DbCluster
Snapshot Attributes Result Contains the results of a successful call to the
DescribeDBClusterSnapshotAttributes
API action.Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the
ModifyDBClusterSnapshotAttribute
API action.- DbCluster
Status Info Reserved for future use.
- DbEngine
Version This data type is used as a response element in the action
DescribeDBEngineVersions
.- DbInstance
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance
,CreateDBInstanceReadReplica
,DeleteDBInstance
,DescribeDBInstances
,ModifyDBInstance
,PromoteReadReplica
,RebootDBInstance
,RestoreDBInstanceFromDBSnapshot
,RestoreDBInstanceFromS3
,RestoreDBInstanceToPointInTime
,StartDBInstance
, andStopDBInstance
.- DbInstance
Automated Backup An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
- DbInstance
Automated Backups Replication Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
- DbInstance
Role Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
- DbInstance
Status Info Provides a list of status information for a DB instance.
- DbMajor
Engine Version This data type is used as a response element in the operation
DescribeDBMajorEngineVersions
.- DbParameter
Group Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the
DescribeDBParameterGroups
action.- DbParameter
Group Status The status of the DB parameter group.
This data type is used as a response element in the following actions:
-
CreateDBInstance
-
CreateDBInstanceReadReplica
-
DeleteDBInstance
-
ModifyDBInstance
-
RebootDBInstance
-
RestoreDBInstanceFromDBSnapshot
-
- DbProxy
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the
DescribeDBProxies
action.- DbProxy
Endpoint The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the
DescribeDBProxyEndpoints
operation.- DbProxy
Target Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the
DescribeDBProxyTargets
action.- DbProxy
Target Group Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the
DescribeDBProxyTargetGroups
action.- DbRecommendation
The recommendation for your DB instances, DB clusters, and DB parameter groups.
- DbSecurity
Group Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the
DescribeDBSecurityGroups
action.- DbSecurity
Group Membership This data type is used as a response element in the following actions:
-
ModifyDBInstance
-
RebootDBInstance
-
RestoreDBInstanceFromDBSnapshot
-
RestoreDBInstanceToPointInTime
-
- DbShard
Group Contains the details for an Amazon RDS DB shard group.
- DbSnapshot
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the
DescribeDBSnapshots
action.- DbSnapshot
Attribute Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API.- DbSnapshot
Attributes Result Contains the results of a successful call to the
DescribeDBSnapshotAttributes
API action.Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the
ModifyDBSnapshotAttribute
API action.- DbSnapshot
Tenant Database Contains the details of a tenant database in a snapshot of a DB instance.
- DbSubnet
Group Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the
DescribeDBSubnetGroups
action.- Describe
DbLog Files Details This data type is used as a response element to
DescribeDBLogFiles
.- DocLink
A link to documentation that provides additional information for a recommendation.
- Domain
Membership An Active Directory Domain membership record associated with the DB instance or cluster.
- Double
Range A range of double values.
- Ec2Security
Group This data type is used as a response element in the following actions:
-
AuthorizeDBSecurityGroupIngress
-
DescribeDBSecurityGroups
-
RevokeDBSecurityGroupIngress
-
- Endpoint
This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:
-
CreateDBInstance
-
DescribeDBInstances
-
DeleteDBInstance
For the data structure that represents Amazon Aurora DB cluster endpoints, see
DBClusterEndpoint
.-
- Engine
Defaults Contains the result of a successful invocation of the
DescribeEngineDefaultParameters
action.- Event
This data type is used as a response element in the DescribeEvents action.
- Event
Categories Map Contains the results of a successful invocation of the DescribeEventCategories operation.
- Event
Subscription Contains the results of a successful invocation of the
DescribeEventSubscriptions
action.- Export
Task Contains the details of a snapshot or cluster export to Amazon S3.
This data type is used as a response element in the
DescribeExportTasks
operation.- Failover
State Contains the state of scheduled or in-process operations on a global cluster (Aurora global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Aurora global database.
- Filter
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Currently, wildcards are not supported in filters.
The following actions can be filtered:
-
DescribeDBClusterBacktracks
-
DescribeDBClusterEndpoints
-
DescribeDBClusters
-
DescribeDBInstances
-
DescribeDBRecommendations
-
DescribeDBShardGroups
-
DescribePendingMaintenanceActions
-
- Global
Cluster A data type representing an Aurora global database.
- Global
Cluster Member A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database).
- Integration
A zero-ETL integration with Amazon Redshift.
- Integration
Error An error associated with a zero-ETL integration with Amazon Redshift.
- IpRange
This data type is used as a response element in the
DescribeDBSecurityGroups
action.- Issue
Details The details of an issue with your DB instances, DB clusters, and DB parameter groups.
- Limitless
Database Contains details for Aurora Limitless Database.
- Master
User Secret Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
- Metric
The representation of a metric.
- Metric
Query The query to retrieve metric data points.
- Metric
Reference The reference (threshold) for a metric.
- Minimum
Engine Version PerAllowed Value The minimum DB engine version required for each corresponding allowed value for an option setting.
- Option
The details of an option.
- Option
Configuration A list of all available options for an option group.
- Option
Group - Option
Group Membership Provides information on the option groups the DB instance is a member of.
- Option
Group Option Available option.
- Option
Group Option Setting Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
- Option
Setting Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
- Option
Version The version for an option. Option group option versions are returned by the
DescribeOptionGroupOptions
action.- Orderable
DbInstance Option Contains a list of available options for a DB instance.
This data type is used as a response element in the
DescribeOrderableDBInstanceOptions
action.- Outpost
A data type that represents an Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
- Parameter
This data type is used as a request parameter in the
ModifyDBParameterGroup
andResetDBParameterGroup
actions.This data type is used as a response element in the
DescribeEngineDefaultParameters
andDescribeDBParameters
actions.- Pending
Cloudwatch Logs Exports A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
- Pending
Maintenance Action Provides information about a pending maintenance action for a resource.
- Pending
Modified Values This data type is used as a response element in the
ModifyDBInstance
operation and contains changes that will be applied during the next maintenance window.- Performance
Insights Metric Dimension Group A logical grouping of Performance Insights metrics for a related subject area. For example, the
db.sql
dimension group consists of the following dimensions:-
db.sql.id
- The hash of a running SQL statement, generated by Performance Insights. -
db.sql.db_id
- Either the SQL ID generated by the database engine, or a value generated by Performance Insights that begins withpi-
. -
db.sql.statement
- The full text of the SQL statement that is running, for example,SELECT * FROM employees
. -
db.sql_tokenized.id
- The hash of the SQL digest generated by Performance Insights.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
-
- Performance
Insights Metric Query A single Performance Insights metric query to process. You must provide the metric to the query. If other parameters aren't specified, Performance Insights returns all data points for the specified metric. Optionally, you can request the data points to be aggregated by dimension group (
GroupBy
) and return only those data points that match your criteria (Filter
).Constraints:
-
Must be a valid Performance Insights query.
-
- Performance
Issue Details Details of the performance issue.
- Processor
Feature Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the
coreCount
feature name for theName
parameter. To specify the number of threads per core, use thethreadsPerCore
feature name for theName
parameter.You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
-
CreateDBInstance
-
ModifyDBInstance
-
RestoreDBInstanceFromDBSnapshot
-
RestoreDBInstanceFromS3
-
RestoreDBInstanceToPointInTime
You can view the valid processor values for a particular instance class by calling the
DescribeOrderableDBInstanceOptions
action and specifying the instance class for theDBInstanceClass
parameter.In addition, you can use the following actions for DB instance class processor information:
-
DescribeDBInstances
-
DescribeDBSnapshots
-
DescribeValidDBInstanceModifications
If you call
DescribeDBInstances
,ProcessorFeature
returns non-null values only if the following conditions are met:-
You are accessing an Oracle DB instance.
-
Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
-
The current number CPU cores and threads is set to a non-default value.
For more information, see Configuring the processor for a DB instance class in RDS for Oracle in the Amazon RDS User Guide.
-
- Range
A range of integer values.
- RdsCustom
Cluster Configuration Reserved for future use.
- Recommended
Action The recommended actions to apply to resolve the issues associated with your DB instances, DB clusters, and DB parameter groups.
- Recommended
Action Parameter A single parameter to use with the
RecommendedAction
API operation to apply the action.- Recommended
Action Update The recommended status to update for the specified recommendation action ID.
- Recurring
Charge This data type is used as a response element in the
DescribeReservedDBInstances
andDescribeReservedDBInstancesOfferings
actions.- Reference
Details The reference details of a metric.
- Reserved
DbInstance This data type is used as a response element in the
DescribeReservedDBInstances
andPurchaseReservedDBInstancesOffering
actions.- Reserved
DbInstances Offering This data type is used as a response element in the
DescribeReservedDBInstancesOfferings
action.- Resource
Pending Maintenance Actions Describes the pending maintenance actions for a resource.
- Restore
Window Earliest and latest time an instance can be restored to:
- Scalar
Reference Details The metric reference details when the reference is a scalar.
- Scaling
Configuration Contains the scaling configuration of an Aurora Serverless v1 DB cluster.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- Scaling
Configuration Info The scaling configuration for an Aurora DB cluster in
serverless
DB engine mode.For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
- Serverless
V2Features Support Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions and platform versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features.
- Serverless
V2Scaling Configuration Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- Serverless
V2Scaling Configuration Info The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
- Source
Region Contains an Amazon Web Services Region name as the result of a successful call to the
DescribeSourceRegions
action.- Subnet
This data type is used as a response element for the
DescribeDBSubnetGroups
operation.- Supported
Engine Lifecycle This data type is used as a response element in the operation
DescribeDBMajorEngineVersions
.You can use the information that this data type returns to plan for upgrades.
This data type only returns information for the open source engines Amazon RDS for MariaDB, Amazon RDS for MySQL, Amazon RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL.
- Switchover
Detail Contains the details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- Tag
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
- Target
Health Information about the connection health of an RDS Proxy target.
- Tenant
Database A tenant database in the DB instance. This data type is an element in the response to the
DescribeTenantDatabases
action.- Tenant
Database Pending Modified Values A response element in the
ModifyTenantDatabase
operation that describes changes that will be applied. Specific changes are identified by subelements.- Timezone
A time zone associated with a
DBInstance
or aDBSnapshot
. This data type is an element in the response to theDescribeDBInstances
, theDescribeDBSnapshots
, and theDescribeDBEngineVersions
actions.- Upgrade
Target The version of the database engine that a DB instance can be upgraded to.
- User
Auth Config Specifies the details of authentication used by a proxy to log in as a specific database user.
- User
Auth Config Info Returns the details of authentication used by a proxy to log in as a specific database user.
- Valid
DbInstance Modifications Message Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the
DescribeValidDBInstanceModifications
action. You can use this information when you callModifyDBInstance
.- Valid
Storage Options Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the
DescribeValidDBInstanceModifications
action.- VpcSecurity
Group Membership This data type is used as a response element for queries on VPC security group membership.
Enums§
- Activity
Stream Mode - When writing a match expression against
ActivityStreamMode
, 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. - Activity
Stream Policy Status - When writing a match expression against
ActivityStreamPolicyStatus
, 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. - Activity
Stream Status - When writing a match expression against
ActivityStreamStatus
, 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. - 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. - Audit
Policy State - When writing a match expression against
AuditPolicyState
, 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. - Auth
Scheme - When writing a match expression against
AuthScheme
, 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. - Automation
Mode - When writing a match expression against
AutomationMode
, 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. - Client
Password Auth Type - When writing a match expression against
ClientPasswordAuthType
, 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. - Cluster
Scalability Type - When writing a match expression against
ClusterScalabilityType
, 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. - Custom
Engine Version Status - When writing a match expression against
CustomEngineVersionStatus
, 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. - Database
Insights Mode - When writing a match expression against
DatabaseInsightsMode
, 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. - DbProxy
Endpoint Status - When writing a match expression against
DbProxyEndpointStatus
, 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. - DbProxy
Endpoint Target Role - When writing a match expression against
DbProxyEndpointTargetRole
, 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. - DbProxy
Status - When writing a match expression against
DbProxyStatus
, 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. - Default
Auth Scheme - When writing a match expression against
DefaultAuthScheme
, 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. - Endpoint
Network Type - When writing a match expression against
EndpointNetworkType
, 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. - Engine
Family - When writing a match expression against
EngineFamily
, 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. - Export
Source Type - When writing a match expression against
ExportSourceType
, 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. - Failover
Status - When writing a match expression against
FailoverStatus
, 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. - Global
Cluster Member Synchronization Status - When writing a match expression against
GlobalClusterMemberSynchronizationStatus
, 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. - IamAuth
Mode - When writing a match expression against
IamAuthMode
, 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. - Integration
Status - When writing a match expression against
IntegrationStatus
, 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. - Lifecycle
Support Name - When writing a match expression against
LifecycleSupportName
, 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. - Limitless
Database Status - When writing a match expression against
LimitlessDatabaseStatus
, 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. - Local
Write Forwarding Status - When writing a match expression against
LocalWriteForwardingStatus
, 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. - Master
User Authentication Type - When writing a match expression against
MasterUserAuthenticationType
, 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. - Replica
Mode - When writing a match expression against
ReplicaMode
, 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. - Target
Connection Network Type - When writing a match expression against
TargetConnectionNetworkType
, 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. - Target
Health Reason - When writing a match expression against
TargetHealthReason
, 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. - Target
Role - When writing a match expression against
TargetRole
, 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. - Target
State - When writing a match expression against
TargetState
, 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. - Target
Type - When writing a match expression against
TargetType
, 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. - Write
Forwarding Status - When writing a match expression against
WriteForwardingStatus
, 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.