AwsAmazonMqBrokerDetails
Provides details about an Amazon MQ message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
Contents
- AuthenticationStrategy
-
The authentication strategy used to secure the broker. The default is
SIMPLE.Type: String
Pattern:
.*\S.*Required: No
- AutoMinorVersionUpgrade
-
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
Type: Boolean
Required: No
- BrokerArn
-
The Amazon Resource Name (ARN) of the broker.
Type: String
Pattern:
.*\S.*Required: No
- BrokerId
-
The unique ID that Amazon MQ generates for the broker.
Type: String
Pattern:
.*\S.*Required: No
- BrokerName
-
The broker's name.
Type: String
Pattern:
.*\S.*Required: No
- DeploymentMode
-
The broker's deployment mode.
Type: String
Pattern:
.*\S.*Required: No
- EncryptionOptions
-
Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
Type: AwsAmazonMqBrokerEncryptionOptionsDetails object
Required: No
- EngineType
-
The type of broker engine.
Type: String
Pattern:
.*\S.*Required: No
- EngineVersion
-
The version of the broker engine.
Type: String
Pattern:
.*\S.*Required: No
- HostInstanceType
-
The broker's instance type.
Type: String
Pattern:
.*\S.*Required: No
- LdapServerMetadata
-
The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.
Type: AwsAmazonMqBrokerLdapServerMetadataDetails object
Required: No
- Logs
-
Turns on Amazon CloudWatch logging for brokers.
Type: AwsAmazonMqBrokerLogsDetails object
Required: No
- MaintenanceWindowStartTime
-
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
Type: AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails object
Required: No
- PubliclyAccessible
-
Permits connections from applications outside of the VPC that hosts the broker's subnets.
Type: Boolean
Required: No
- SecurityGroups
-
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
Type: Array of strings
Pattern:
.*\S.*Required: No
- StorageType
-
The broker's storage type.
Type: String
Pattern:
.*\S.*Required: No
- SubnetIds
-
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
Type: Array of strings
Pattern:
.*\S.*Required: No
- Users
-
The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
Type: Array of AwsAmazonMqBrokerUsersDetails objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
