Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Action
Required Action required for a broker.
- Availability
Zone Name of the availability zone.
- Broker
Engine Type Types of broker engines.
- Broker
Instance Returns information about all brokers.
- Broker
Instance Option Option for host instance type.
- Broker
Summary Returns information about all brokers.
- Configuration
Returns information about all configurations.
- Configuration
Id A list of information about the configuration.
- Configuration
Revision Returns information about the specified configuration revision.
- Configurations
Broker configuration information
- Data
Replication Counterpart Specifies a broker in a data replication pair.
- Data
Replication Metadata Output The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.
- Encryption
Options Encryption options for the broker.
- Engine
Version Id of the engine version.
- Ldap
Server Metadata Input Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Does not apply to RabbitMQ brokers.
- Ldap
Server Metadata Output Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
- Logs
The list of information about logs to be enabled for the specified broker.
- Logs
Summary The list of information about logs currently enabled and pending to be deployed for the specified broker.
- Pending
Logs The list of information about logs to be enabled for the specified broker.
- Sanitization
Warning Returns information about the configuration element or attribute that was sanitized in the configuration.
- User
A user associated with the broker. For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
- User
Pending Changes Returns information about the status of the changes pending for the ActiveMQ user.
- User
Summary Returns a list of all broker users. Does not apply to RabbitMQ brokers.
- Weekly
Start Time The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
Enums§
- Authentication
Strategy - When writing a match expression against
AuthenticationStrategy
, 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. - Broker
State - When writing a match expression against
BrokerState
, 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. - Broker
Storage Type - When writing a match expression against
BrokerStorageType
, 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. - Change
Type - When writing a match expression against
ChangeType
, 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. - Data
Replication Mode - When writing a match expression against
DataReplicationMode
, 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. - DayOf
Week - When writing a match expression against
DayOfWeek
, 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. - Deployment
Mode - When writing a match expression against
DeploymentMode
, 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
Type - When writing a match expression against
EngineType
, 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. - Promote
Mode - When writing a match expression against
PromoteMode
, 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. - Sanitization
Warning Reason - When writing a match expression against
SanitizationWarningReason
, 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.