2020/07/24 - AmazonMQ - 6 updated api methods
Changes Amazon MQ now supports LDAP (Lightweight Directory Access Protocol), providing authentication and authorization of Amazon MQ users via a customer designated LDAP server.
{'AuthenticationStrategy': 'SIMPLE | LDAP',
'LdapServerMetadata': {'Hosts': ['string'],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': 'boolean',
'ServiceAccountPassword': 'string',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': 'boolean'}}
Creates a broker. Note: This API is asynchronous.
See also: AWS API Documentation
Request Syntax
client.create_broker(
AuthenticationStrategy='SIMPLE'|'LDAP',
AutoMinorVersionUpgrade=True|False,
BrokerName='string',
Configuration={
'Id': 'string',
'Revision': 123
},
CreatorRequestId='string',
DeploymentMode='SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
EncryptionOptions={
'KmsKeyId': 'string',
'UseAwsOwnedKey': True|False
},
EngineType='ACTIVEMQ',
EngineVersion='string',
HostInstanceType='string',
LdapServerMetadata={
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountPassword': 'string',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
Logs={
'Audit': True|False,
'General': True|False
},
MaintenanceWindowStartTime={
'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'TimeOfDay': 'string',
'TimeZone': 'string'
},
PubliclyAccessible=True|False,
SecurityGroups=[
'string',
],
StorageType='EBS'|'EFS',
SubnetIds=[
'string',
],
Tags={
'string': 'string'
},
Users=[
{
'ConsoleAccess': True|False,
'Groups': [
'string',
],
'Password': 'string',
'Username': 'string'
},
]
)
string
The authentication strategy used to secure the broker.
boolean
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
string
Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
dict
A list of information about the configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
string
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.This field is autopopulated if not provided.
string
Required. The deployment mode of the broker.
dict
Encryption options for the broker.
KmsKeyId (string) -- The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
UseAwsOwnedKey (boolean) -- [REQUIRED] Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
string
Required. The broker's instance type.
dict
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) -- Fully qualified domain name of the LDAP server. Optional failover server.
(string) --
RoleBase (string) -- Fully qualified name of the directory to search for a user’s groups.
RoleName (string) -- Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) -- The search criteria for groups.
RoleSearchSubtree (boolean) -- The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountPassword (string) -- Service account password.
ServiceAccountUsername (string) -- Service account username.
UserBase (string) -- Fully qualified name of the directory where you want to search for users.
UserRoleName (string) -- Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) -- The search criteria for users.
UserSearchSubtree (boolean) -- The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
dict
Enables Amazon CloudWatch logging for brokers.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
dict
The parameters that determine the WeeklyStartTime.
DayOfWeek (string) -- Required. The day of the week.
TimeOfDay (string) -- Required. The time, in 24-hour format.
TimeZone (string) -- The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
boolean
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
list
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) --
string
The broker's storage type.
list
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
(string) --
dict
Create tags when creating the broker.
(string) --
(string) --
list
Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
(dict) -- An ActiveMQ user associated with the broker.
ConsoleAccess (boolean) -- Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
Groups (list) -- The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
(string) --
Password (string) -- Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas.
Username (string) -- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
dict
Response Syntax
{
'BrokerArn': 'string',
'BrokerId': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.
{'AuthenticationStrategy': 'SIMPLE | LDAP'}
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
See also: AWS API Documentation
Request Syntax
client.create_configuration(
AuthenticationStrategy='SIMPLE'|'LDAP',
EngineType='ACTIVEMQ',
EngineVersion='string',
Name='string',
Tags={
'string': 'string'
}
)
string
The authentication strategy associated with the configuration.
string
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
string
Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
string
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
dict
Create tags when creating the configuration.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'Created': datetime(2015, 1, 1),
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
Arn (string) -- Required. The Amazon Resource Name (ARN) of the configuration.
AuthenticationStrategy (string) -- The authentication strategy associated with the configuration.
Created (datetime) -- Required. The date and time of the configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision (dict) -- The latest revision of the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- The description of the configuration revision.
Revision (integer) -- Required. The revision number of the configuration.
Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
{'AuthenticationStrategy': 'SIMPLE | LDAP',
'LdapServerMetadata': {'Hosts': ['string'],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': 'boolean',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': 'boolean'},
'PendingAuthenticationStrategy': 'SIMPLE | LDAP',
'PendingLdapServerMetadata': {'Hosts': ['string'],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': 'boolean',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': 'boolean'}}
Returns information about the specified broker.
See also: AWS API Documentation
Request Syntax
client.describe_broker(
BrokerId='string'
)
string
[REQUIRED] The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
dict
Response Syntax
{
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'AutoMinorVersionUpgrade': True|False,
'BrokerArn': 'string',
'BrokerId': 'string',
'BrokerInstances': [
{
'ConsoleURL': 'string',
'Endpoints': [
'string',
],
'IpAddress': 'string'
},
],
'BrokerName': 'string',
'BrokerState': 'CREATION_IN_PROGRESS'|'CREATION_FAILED'|'DELETION_IN_PROGRESS'|'RUNNING'|'REBOOT_IN_PROGRESS',
'Configurations': {
'Current': {
'Id': 'string',
'Revision': 123
},
'History': [
{
'Id': 'string',
'Revision': 123
},
],
'Pending': {
'Id': 'string',
'Revision': 123
}
},
'Created': datetime(2015, 1, 1),
'DeploymentMode': 'SINGLE_INSTANCE'|'ACTIVE_STANDBY_MULTI_AZ',
'EncryptionOptions': {
'KmsKeyId': 'string',
'UseAwsOwnedKey': True|False
},
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'HostInstanceType': 'string',
'LdapServerMetadata': {
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
'Logs': {
'Audit': True|False,
'AuditLogGroup': 'string',
'General': True|False,
'GeneralLogGroup': 'string',
'Pending': {
'Audit': True|False,
'General': True|False
}
},
'MaintenanceWindowStartTime': {
'DayOfWeek': 'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY'|'SUNDAY',
'TimeOfDay': 'string',
'TimeZone': 'string'
},
'PendingAuthenticationStrategy': 'SIMPLE'|'LDAP',
'PendingEngineVersion': 'string',
'PendingHostInstanceType': 'string',
'PendingLdapServerMetadata': {
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
'PendingSecurityGroups': [
'string',
],
'PubliclyAccessible': True|False,
'SecurityGroups': [
'string',
],
'StorageType': 'EBS'|'EFS',
'SubnetIds': [
'string',
],
'Tags': {
'string': 'string'
},
'Users': [
{
'PendingChange': 'CREATE'|'UPDATE'|'DELETE',
'Username': 'string'
},
]
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
AuthenticationStrategy (string) -- The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade (boolean) -- Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
BrokerArn (string) -- The Amazon Resource Name (ARN) of the broker.
BrokerId (string) -- The unique ID that Amazon MQ generates for the broker.
BrokerInstances (list) -- A list of information about allocated brokers.
(dict) -- Returns information about all brokers.
ConsoleURL (string) -- The URL of the broker's ActiveMQ Web Console.
Endpoints (list) -- The broker's wire-level protocol endpoints.
(string) --
IpAddress (string) -- The IP address of the Elastic Network Interface (ENI) attached to the broker.
BrokerName (string) -- The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters.
BrokerState (string) -- The status of the broker.
Configurations (dict) -- The list of all revisions for the specified configuration.
Current (dict) -- The current configuration of the broker.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
History (list) -- The history of configurations applied to the broker.
(dict) -- A list of information about the configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
Pending (dict) -- The pending configuration of the broker.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
Created (datetime) -- The time when the broker was created.
DeploymentMode (string) -- Required. The deployment mode of the broker.
EncryptionOptions (dict) -- Encryption options for the broker.
KmsKeyId (string) -- The symmetric customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.
UseAwsOwnedKey (boolean) -- Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).
EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
EngineVersion (string) -- The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType (string) -- The broker's instance type.
LdapServerMetadata (dict) -- The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) -- Fully qualified domain name of the LDAP server. Optional failover server.
(string) --
RoleBase (string) -- Fully qualified name of the directory to search for a user’s groups.
RoleName (string) -- Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) -- The search criteria for groups.
RoleSearchSubtree (boolean) -- The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername (string) -- Service account username.
UserBase (string) -- Fully qualified name of the directory where you want to search for users.
UserRoleName (string) -- Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) -- The search criteria for users.
UserSearchSubtree (boolean) -- The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
Logs (dict) -- The list of information about logs currently enabled and pending to be deployed for the specified broker.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
AuditLogGroup (string) -- The location of the CloudWatch Logs log group where audit logs are sent.
General (boolean) -- Enables general logging.
GeneralLogGroup (string) -- The location of the CloudWatch Logs log group where general logs are sent.
Pending (dict) -- The list of information about logs pending to be deployed for the specified broker.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
MaintenanceWindowStartTime (dict) -- The parameters that determine the WeeklyStartTime.
DayOfWeek (string) -- Required. The day of the week.
TimeOfDay (string) -- Required. The time, in 24-hour format.
TimeZone (string) -- The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
PendingAuthenticationStrategy (string) -- The authentication strategy that will be applied when the broker is rebooted.
PendingEngineVersion (string) -- The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
PendingHostInstanceType (string) -- The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
PendingLdapServerMetadata (dict) -- The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker once it is rebooted.
Hosts (list) -- Fully qualified domain name of the LDAP server. Optional failover server.
(string) --
RoleBase (string) -- Fully qualified name of the directory to search for a user’s groups.
RoleName (string) -- Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) -- The search criteria for groups.
RoleSearchSubtree (boolean) -- The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername (string) -- Service account username.
UserBase (string) -- Fully qualified name of the directory where you want to search for users.
UserRoleName (string) -- Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) -- The search criteria for users.
UserSearchSubtree (boolean) -- The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
PendingSecurityGroups (list) -- The list of pending security groups to authorize connections to brokers.
(string) --
PubliclyAccessible (boolean) -- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
SecurityGroups (list) -- The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) --
StorageType (string) -- The broker's storage type.
SubnetIds (list) -- The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
(string) --
Tags (dict) -- The list of all tags associated with this broker.
(string) --
(string) --
Users (list) -- The list of all ActiveMQ usernames for the specified broker.
(dict) -- Returns a list of all ActiveMQ users.
PendingChange (string) -- The type of change pending for the ActiveMQ user.
Username (string) -- Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
{'AuthenticationStrategy': 'SIMPLE | LDAP'}
Returns information about the specified configuration.
See also: AWS API Documentation
Request Syntax
client.describe_configuration(
ConfigurationId='string'
)
string
[REQUIRED] The unique ID that Amazon MQ generates for the configuration.
dict
Response Syntax
{
'Arn': 'string',
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
Arn (string) -- Required. The ARN of the configuration.
AuthenticationStrategy (string) -- The authentication strategy associated with the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- Required. The description of the configuration.
EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
EngineVersion (string) -- Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision (dict) -- Required. The latest revision of the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- The description of the configuration revision.
Revision (integer) -- Required. The revision number of the configuration.
Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Tags (dict) -- The list of all tags associated with this configuration.
(string) --
(string) --
{'Configurations': {'AuthenticationStrategy': 'SIMPLE | LDAP'}}
Returns a list of all configurations.
See also: AWS API Documentation
Request Syntax
client.list_configurations(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
string
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
dict
Response Syntax
{
'Configurations': [
{
'Arn': 'string',
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'EngineType': 'ACTIVEMQ',
'EngineVersion': 'string',
'Id': 'string',
'LatestRevision': {
'Created': datetime(2015, 1, 1),
'Description': 'string',
'Revision': 123
},
'Name': 'string',
'Tags': {
'string': 'string'
}
},
],
'MaxResults': 123,
'NextToken': 'string'
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
Configurations (list) -- The list of all revisions for the specified configuration.
(dict) -- Returns information about all configurations.
Arn (string) -- Required. The ARN of the configuration.
AuthenticationStrategy (string) -- The authentication strategy associated with the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- Required. The description of the configuration.
EngineType (string) -- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
EngineVersion (string) -- Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
LatestRevision (dict) -- Required. The latest revision of the configuration.
Created (datetime) -- Required. The date and time of the configuration revision.
Description (string) -- The description of the configuration revision.
Revision (integer) -- Required. The revision number of the configuration.
Name (string) -- Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
Tags (dict) -- The list of all tags associated with this configuration.
(string) --
(string) --
MaxResults (integer) -- The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
NextToken (string) -- The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
{'AuthenticationStrategy': 'SIMPLE | LDAP',
'LdapServerMetadata': {'Hosts': ['string'],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': 'boolean',
'ServiceAccountPassword': 'string',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': 'boolean'}}
Response {'AuthenticationStrategy': 'SIMPLE | LDAP',
'LdapServerMetadata': {'Hosts': ['string'],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': 'boolean',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': 'boolean'}}
Adds a pending configuration change to a broker.
See also: AWS API Documentation
Request Syntax
client.update_broker(
AuthenticationStrategy='SIMPLE'|'LDAP',
AutoMinorVersionUpgrade=True|False,
BrokerId='string',
Configuration={
'Id': 'string',
'Revision': 123
},
EngineVersion='string',
HostInstanceType='string',
LdapServerMetadata={
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountPassword': 'string',
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
Logs={
'Audit': True|False,
'General': True|False
},
SecurityGroups=[
'string',
]
)
string
The authentication strategy used to secure the broker.
boolean
Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
string
[REQUIRED] The unique ID that Amazon MQ generates for the broker.
dict
A list of information about the configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
string
The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
string
The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
dict
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) -- Fully qualified domain name of the LDAP server. Optional failover server.
(string) --
RoleBase (string) -- Fully qualified name of the directory to search for a user’s groups.
RoleName (string) -- Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) -- The search criteria for groups.
RoleSearchSubtree (boolean) -- The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountPassword (string) -- Service account password.
ServiceAccountUsername (string) -- Service account username.
UserBase (string) -- Fully qualified name of the directory where you want to search for users.
UserRoleName (string) -- Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) -- The search criteria for users.
UserSearchSubtree (boolean) -- The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
dict
Enables Amazon CloudWatch logging for brokers.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
list
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) --
dict
Response Syntax
{
'AuthenticationStrategy': 'SIMPLE'|'LDAP',
'AutoMinorVersionUpgrade': True|False,
'BrokerId': 'string',
'Configuration': {
'Id': 'string',
'Revision': 123
},
'EngineVersion': 'string',
'HostInstanceType': 'string',
'LdapServerMetadata': {
'Hosts': [
'string',
],
'RoleBase': 'string',
'RoleName': 'string',
'RoleSearchMatching': 'string',
'RoleSearchSubtree': True|False,
'ServiceAccountUsername': 'string',
'UserBase': 'string',
'UserRoleName': 'string',
'UserSearchMatching': 'string',
'UserSearchSubtree': True|False
},
'Logs': {
'Audit': True|False,
'General': True|False
},
'SecurityGroups': [
'string',
]
}
Response Structure
(dict) -- HTTP Status Code 200: OK.
AuthenticationStrategy (string) -- The authentication strategy used to secure the broker.
AutoMinorVersionUpgrade (boolean) -- The new value of automatic upgrades to new minor version for brokers.
BrokerId (string) -- Required. The unique ID that Amazon MQ generates for the broker.
Configuration (dict) -- The ID of the updated configuration.
Id (string) -- Required. The unique ID that Amazon MQ generates for the configuration.
Revision (integer) -- The revision number of the configuration.
EngineVersion (string) -- The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
HostInstanceType (string) -- The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
LdapServerMetadata (dict) -- The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Hosts (list) -- Fully qualified domain name of the LDAP server. Optional failover server.
(string) --
RoleBase (string) -- Fully qualified name of the directory to search for a user’s groups.
RoleName (string) -- Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
RoleSearchMatching (string) -- The search criteria for groups.
RoleSearchSubtree (boolean) -- The directory search scope for the role. If set to true, scope is to search the entire sub-tree.
ServiceAccountUsername (string) -- Service account username.
UserBase (string) -- Fully qualified name of the directory where you want to search for users.
UserRoleName (string) -- Specifies the name of the LDAP attribute for the user group membership.
UserSearchMatching (string) -- The search criteria for users.
UserSearchSubtree (boolean) -- The directory search scope for the user. If set to true, scope is to search the entire sub-tree.
Logs (dict) -- The list of information about logs to be enabled for the specified broker.
Audit (boolean) -- Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
General (boolean) -- Enables general logging.
SecurityGroups (list) -- The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
(string) --