SDK for PHP 3.x

AmazonMQ 2017-11-27

Client: Aws\MQ\MQClient
Service ID: mq
Version: 2017-11-27

This page describes the parameters and results for the operations of the AmazonMQ (2017-11-27), and shows how to use the Aws\MQ\MQClient object to call the described operations. This documentation is specific to the 2017-11-27 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateBroker ( array $params = [] )
Creates a broker.
CreateConfiguration ( array $params = [] )
Creates a new configuration for the specified configuration name.
CreateTags ( array $params = [] )
Add a tag to a resource.
CreateUser ( array $params = [] )
Creates an ActiveMQ user.
DeleteBroker ( array $params = [] )
Deletes a broker.
DeleteTags ( array $params = [] )
Removes a tag from a resource.
DeleteUser ( array $params = [] )
Deletes an ActiveMQ user.
DescribeBroker ( array $params = [] )
Returns information about the specified broker.
DescribeBrokerEngineTypes ( array $params = [] )
Describe available engine types and versions.
DescribeBrokerInstanceOptions ( array $params = [] )
Describe available broker instance options.
DescribeConfiguration ( array $params = [] )
Returns information about the specified configuration.
DescribeConfigurationRevision ( array $params = [] )
Returns the specified configuration revision for the specified configuration.
DescribeUser ( array $params = [] )
Returns information about an ActiveMQ user.
ListBrokers ( array $params = [] )
Returns a list of all brokers.
ListConfigurationRevisions ( array $params = [] )
Returns a list of all revisions for the specified configuration.
ListConfigurations ( array $params = [] )
Returns a list of all configurations.
ListTags ( array $params = [] )
Lists tags for a resource.
ListUsers ( array $params = [] )
Returns a list of all ActiveMQ users.
Promote ( array $params = [] )
Promotes a data replication replica broker to the primary broker role.
RebootBroker ( array $params = [] )
Reboots a broker.
UpdateBroker ( array $params = [] )
Adds a pending configuration change to a broker.
UpdateConfiguration ( array $params = [] )
Updates the specified configuration.
UpdateUser ( array $params = [] )
Updates the information for an ActiveMQ user.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListBrokers

Operations

CreateBroker 

$result = $client->createBroker([/* ... */]);
$promise = $client->createBrokerAsync([/* ... */]);

Creates a broker. Note: This API is asynchronous.

To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

  • ec2:CreateNetworkInterface

    This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

  • ec2:CreateNetworkInterfacePermission

    This permission is required to attach the ENI to the broker instance.

  • ec2:DeleteNetworkInterface

  • ec2:DeleteNetworkInterfacePermission

  • ec2:DetachNetworkInterface

  • ec2:DescribeInternetGateways

  • ec2:DescribeNetworkInterfaces

  • ec2:DescribeNetworkInterfacePermissions

  • ec2:DescribeRouteTables

  • ec2:DescribeSecurityGroups

  • ec2:DescribeSubnets

  • ec2:DescribeVpcs

For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

Parameter Syntax

$result = $client->createBroker([
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerName' => '<string>', // REQUIRED
    'Configuration' => [
        'Id' => '<string>', // REQUIRED
        'Revision' => <integer>,
    ],
    'CreatorRequestId' => '<string>',
    'DataReplicationMode' => 'NONE|CRDR',
    'DataReplicationPrimaryBrokerArn' => '<string>',
    'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ|CLUSTER_MULTI_AZ', // REQUIRED
    'EncryptionOptions' => [
        'KmsKeyId' => '<string>',
        'UseAwsOwnedKey' => true || false, // REQUIRED
    ],
    'EngineType' => 'ACTIVEMQ|RABBITMQ', // REQUIRED
    'EngineVersion' => '<string>',
    'HostInstanceType' => '<string>', // REQUIRED
    'LdapServerMetadata' => [
        'Hosts' => ['<string>', ...], // REQUIRED
        'RoleBase' => '<string>', // REQUIRED
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>', // REQUIRED
        'RoleSearchSubtree' => true || false,
        'ServiceAccountPassword' => '<string>', // REQUIRED
        'ServiceAccountUsername' => '<string>', // REQUIRED
        'UserBase' => '<string>', // REQUIRED
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>', // REQUIRED
        'UserSearchSubtree' => true || false,
    ],
    'Logs' => [
        'Audit' => true || false,
        'General' => true || false,
    ],
    'MaintenanceWindowStartTime' => [
        'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY', // REQUIRED
        'TimeOfDay' => '<string>', // REQUIRED
        'TimeZone' => '<string>',
    ],
    'PubliclyAccessible' => true || false, // REQUIRED
    'SecurityGroups' => ['<string>', ...],
    'StorageType' => 'EBS|EFS',
    'SubnetIds' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'Users' => [ // REQUIRED
        [
            'ConsoleAccess' => true || false,
            'Groups' => ['<string>', ...],
            'Password' => '<string>', // REQUIRED
            'ReplicationUser' => true || false,
            'Username' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean
BrokerName
Required: Yes
Type: string
Configuration
Type: ConfigurationId structure

A list of information about the configuration.

CreatorRequestId
Type: string
DataReplicationMode
Type: string

Specifies whether a broker is a part of a data replication pair.

DataReplicationPrimaryBrokerArn
Type: string
DeploymentMode
Required: Yes
Type: string

The broker's deployment mode.

EncryptionOptions
Type: EncryptionOptions structure

Encryption options for the broker.

EngineType
Required: Yes
Type: string

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

EngineVersion
Type: string
HostInstanceType
Required: Yes
Type: string
LdapServerMetadata
Type: LdapServerMetadataInput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

Logs
Type: Logs structure

The list of information about logs to be enabled for the specified broker.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

PubliclyAccessible
Required: Yes
Type: boolean
SecurityGroups
Type: Array of strings
StorageType
Type: string

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

SubnetIds
Type: Array of strings
Tags
Type: Associative array of custom strings keys (__string) to strings
Users
Required: Yes
Type: Array of User structures

Result Syntax

[
    'BrokerArn' => '<string>',
    'BrokerId' => '<string>',
]

Result Details

Members
BrokerArn
Type: string
BrokerId
Type: string

Errors

BadRequestException:

Returns information about an error.

UnauthorizedException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

CreateConfiguration 

$result = $client->createConfiguration([/* ... */]);
$promise = $client->createConfigurationAsync([/* ... */]);

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Parameter Syntax

$result = $client->createConfiguration([
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'EngineType' => 'ACTIVEMQ|RABBITMQ', // REQUIRED
    'EngineVersion' => '<string>',
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

EngineType
Required: Yes
Type: string

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

EngineVersion
Type: string
Name
Required: Yes
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

Result Syntax

[
    'Arn' => '<string>',
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'Created' => <DateTime>,
    'Id' => '<string>',
    'LatestRevision' => [
        'Created' => <DateTime>,
        'Description' => '<string>',
        'Revision' => <integer>,
    ],
    'Name' => '<string>',
]

Result Details

Members
Arn
Type: string
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

Created
Type: timestamp (string|DateTime or anything parsable by strtotime)
Id
Type: string
LatestRevision
Type: ConfigurationRevision structure

Returns information about the specified configuration revision.

Name
Type: string

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

CreateTags 

$result = $client->createTags([/* ... */]);
$promise = $client->createTagsAsync([/* ... */]);

Add a tag to a resource.

Parameter Syntax

$result = $client->createTags([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

CreateUser 

$result = $client->createUser([/* ... */]);
$promise = $client->createUserAsync([/* ... */]);

Creates an ActiveMQ user.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

Parameter Syntax

$result = $client->createUser([
    'BrokerId' => '<string>', // REQUIRED
    'ConsoleAccess' => true || false,
    'Groups' => ['<string>', ...],
    'Password' => '<string>', // REQUIRED
    'ReplicationUser' => true || false,
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string
ConsoleAccess
Type: boolean
Groups
Type: Array of strings
Password
Required: Yes
Type: string
ReplicationUser
Type: boolean
Username
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DeleteBroker 

$result = $client->deleteBroker([/* ... */]);
$promise = $client->deleteBrokerAsync([/* ... */]);

Deletes a broker. Note: This API is asynchronous.

Parameter Syntax

$result = $client->deleteBroker([
    'BrokerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string

Result Syntax

[
    'BrokerId' => '<string>',
]

Result Details

Members
BrokerId
Type: string

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DeleteTags 

$result = $client->deleteTags([/* ... */]);
$promise = $client->deleteTagsAsync([/* ... */]);

Removes a tag from a resource.

Parameter Syntax

$result = $client->deleteTags([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string
TagKeys
Required: Yes
Type: Array of strings

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DeleteUser 

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Deletes an ActiveMQ user.

Parameter Syntax

$result = $client->deleteUser([
    'BrokerId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string
Username
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeBroker 

$result = $client->describeBroker([/* ... */]);
$promise = $client->describeBrokerAsync([/* ... */]);

Returns information about the specified broker.

Parameter Syntax

$result = $client->describeBroker([
    'BrokerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string

Result Syntax

[
    'ActionsRequired' => [
        [
            'ActionRequiredCode' => '<string>',
            'ActionRequiredInfo' => '<string>',
        ],
        // ...
    ],
    '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|CRITICAL_ACTION_REQUIRED|REPLICA',
    'Configurations' => [
        'Current' => [
            'Id' => '<string>',
            'Revision' => <integer>,
        ],
        'History' => [
            [
                'Id' => '<string>',
                'Revision' => <integer>,
            ],
            // ...
        ],
        'Pending' => [
            'Id' => '<string>',
            'Revision' => <integer>,
        ],
    ],
    'Created' => <DateTime>,
    'DataReplicationMetadata' => [
        'DataReplicationCounterpart' => [
            'BrokerId' => '<string>',
            'Region' => '<string>',
        ],
        'DataReplicationRole' => '<string>',
    ],
    'DataReplicationMode' => 'NONE|CRDR',
    'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ|CLUSTER_MULTI_AZ',
    'EncryptionOptions' => [
        'KmsKeyId' => '<string>',
        'UseAwsOwnedKey' => true || false,
    ],
    'EngineType' => 'ACTIVEMQ|RABBITMQ',
    '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',
    'PendingDataReplicationMetadata' => [
        'DataReplicationCounterpart' => [
            'BrokerId' => '<string>',
            'Region' => '<string>',
        ],
        'DataReplicationRole' => '<string>',
    ],
    'PendingDataReplicationMode' => 'NONE|CRDR',
    '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>', ...],
    'Users' => [
        [
            'PendingChange' => 'CREATE|UPDATE|DELETE',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
ActionsRequired
Type: Array of ActionRequired structures
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean
BrokerArn
Type: string
BrokerId
Type: string
BrokerInstances
Type: Array of BrokerInstance structures
BrokerName
Type: string
BrokerState
Type: string

The broker's status.

Configurations
Type: Configurations structure

Broker configuration information

Created
Type: timestamp (string|DateTime or anything parsable by strtotime)
DataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

DataReplicationMode
Type: string

Specifies whether a broker is a part of a data replication pair.

DeploymentMode
Type: string

The broker's deployment mode.

EncryptionOptions
Type: EncryptionOptions structure

Encryption options for the broker.

EngineType
Type: string

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

EngineVersion
Type: string
HostInstanceType
Type: string
LdapServerMetadata
Type: LdapServerMetadataOutput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Logs
Type: LogsSummary structure

The list of information about logs currently enabled and pending to be deployed for the specified broker.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

PendingAuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

PendingDataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

PendingDataReplicationMode
Type: string

Specifies whether a broker is a part of a data replication pair.

PendingEngineVersion
Type: string
PendingHostInstanceType
Type: string
PendingLdapServerMetadata
Type: LdapServerMetadataOutput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

PendingSecurityGroups
Type: Array of strings
PubliclyAccessible
Type: boolean
SecurityGroups
Type: Array of strings
StorageType
Type: string

The broker's storage type.

EFS is not supported for RabbitMQ engine type.

SubnetIds
Type: Array of strings
Tags
Type: Associative array of custom strings keys (__string) to strings
Users
Type: Array of UserSummary structures

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeBrokerEngineTypes 

$result = $client->describeBrokerEngineTypes([/* ... */]);
$promise = $client->describeBrokerEngineTypesAsync([/* ... */]);

Describe available engine types and versions.

Parameter Syntax

$result = $client->describeBrokerEngineTypes([
    'EngineType' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
EngineType
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'BrokerEngineTypes' => [
        [
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'EngineVersions' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members
BrokerEngineTypes
Type: Array of BrokerEngineType structures
MaxResults
Type: int
NextToken
Type: string

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeBrokerInstanceOptions 

$result = $client->describeBrokerInstanceOptions([/* ... */]);
$promise = $client->describeBrokerInstanceOptionsAsync([/* ... */]);

Describe available broker instance options.

Parameter Syntax

$result = $client->describeBrokerInstanceOptions([
    'EngineType' => '<string>',
    'HostInstanceType' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'StorageType' => '<string>',
]);

Parameter Details

Members
EngineType
Type: string
HostInstanceType
Type: string
MaxResults
Type: int
NextToken
Type: string
StorageType
Type: string

Result Syntax

[
    'BrokerInstanceOptions' => [
        [
            'AvailabilityZones' => [
                [
                    'Name' => '<string>',
                ],
                // ...
            ],
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'HostInstanceType' => '<string>',
            'StorageType' => 'EBS|EFS',
            'SupportedDeploymentModes' => ['<string>', ...],
            'SupportedEngineVersions' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members
BrokerInstanceOptions
Type: Array of BrokerInstanceOption structures
MaxResults
Type: int
NextToken
Type: string

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeConfiguration 

$result = $client->describeConfiguration([/* ... */]);
$promise = $client->describeConfigurationAsync([/* ... */]);

Returns information about the specified configuration.

Parameter Syntax

$result = $client->describeConfiguration([
    'ConfigurationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationId
Required: Yes
Type: string

Result Syntax

[
    'Arn' => '<string>',
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'Created' => <DateTime>,
    'Description' => '<string>',
    'EngineType' => 'ACTIVEMQ|RABBITMQ',
    'EngineVersion' => '<string>',
    'Id' => '<string>',
    'LatestRevision' => [
        'Created' => <DateTime>,
        'Description' => '<string>',
        'Revision' => <integer>,
    ],
    'Name' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Members
Arn
Type: string
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

Created
Type: timestamp (string|DateTime or anything parsable by strtotime)
Description
Type: string
EngineType
Type: string

The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.

EngineVersion
Type: string
Id
Type: string
LatestRevision
Type: ConfigurationRevision structure

Returns information about the specified configuration revision.

Name
Type: string
Tags
Type: Associative array of custom strings keys (__string) to strings

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeConfigurationRevision 

$result = $client->describeConfigurationRevision([/* ... */]);
$promise = $client->describeConfigurationRevisionAsync([/* ... */]);

Returns the specified configuration revision for the specified configuration.

Parameter Syntax

$result = $client->describeConfigurationRevision([
    'ConfigurationId' => '<string>', // REQUIRED
    'ConfigurationRevision' => '<string>', // REQUIRED
]);

Parameter Details

Members
ConfigurationId
Required: Yes
Type: string
ConfigurationRevision
Required: Yes
Type: string

Result Syntax

[
    'ConfigurationId' => '<string>',
    'Created' => <DateTime>,
    'Data' => '<string>',
    'Description' => '<string>',
]

Result Details

Members
ConfigurationId
Type: string
Created
Type: timestamp (string|DateTime or anything parsable by strtotime)
Data
Type: string
Description
Type: string

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

DescribeUser 

$result = $client->describeUser([/* ... */]);
$promise = $client->describeUserAsync([/* ... */]);

Returns information about an ActiveMQ user.

Parameter Syntax

$result = $client->describeUser([
    'BrokerId' => '<string>', // REQUIRED
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string
Username
Required: Yes
Type: string

Result Syntax

[
    'BrokerId' => '<string>',
    'ConsoleAccess' => true || false,
    'Groups' => ['<string>', ...],
    'Pending' => [
        'ConsoleAccess' => true || false,
        'Groups' => ['<string>', ...],
        'PendingChange' => 'CREATE|UPDATE|DELETE',
    ],
    'ReplicationUser' => true || false,
    'Username' => '<string>',
]

Result Details

Members
BrokerId
Type: string
ConsoleAccess
Type: boolean
Groups
Type: Array of strings
Pending
Type: UserPendingChanges structure

Returns information about the status of the changes pending for the ActiveMQ user.

ReplicationUser
Type: boolean
Username
Type: string

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListBrokers 

$result = $client->listBrokers([/* ... */]);
$promise = $client->listBrokersAsync([/* ... */]);

Returns a list of all brokers.

Parameter Syntax

$result = $client->listBrokers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'BrokerSummaries' => [
        [
            'BrokerArn' => '<string>',
            'BrokerId' => '<string>',
            'BrokerName' => '<string>',
            'BrokerState' => 'CREATION_IN_PROGRESS|CREATION_FAILED|DELETION_IN_PROGRESS|RUNNING|REBOOT_IN_PROGRESS|CRITICAL_ACTION_REQUIRED|REPLICA',
            'Created' => <DateTime>,
            'DeploymentMode' => 'SINGLE_INSTANCE|ACTIVE_STANDBY_MULTI_AZ|CLUSTER_MULTI_AZ',
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'HostInstanceType' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
BrokerSummaries
Type: Array of BrokerSummary structures
NextToken
Type: string

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListConfigurationRevisions 

$result = $client->listConfigurationRevisions([/* ... */]);
$promise = $client->listConfigurationRevisionsAsync([/* ... */]);

Returns a list of all revisions for the specified configuration.

Parameter Syntax

$result = $client->listConfigurationRevisions([
    'ConfigurationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ConfigurationId
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'ConfigurationId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Revisions' => [
        [
            'Created' => <DateTime>,
            'Description' => '<string>',
            'Revision' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members
ConfigurationId
Type: string
MaxResults
Type: int
NextToken
Type: string
Revisions
Type: Array of ConfigurationRevision structures

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListConfigurations 

$result = $client->listConfigurations([/* ... */]);
$promise = $client->listConfigurationsAsync([/* ... */]);

Returns a list of all configurations.

Parameter Syntax

$result = $client->listConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'Configurations' => [
        [
            'Arn' => '<string>',
            'AuthenticationStrategy' => 'SIMPLE|LDAP',
            'Created' => <DateTime>,
            'Description' => '<string>',
            'EngineType' => 'ACTIVEMQ|RABBITMQ',
            'EngineVersion' => '<string>',
            'Id' => '<string>',
            'LatestRevision' => [
                'Created' => <DateTime>,
                'Description' => '<string>',
                'Revision' => <integer>,
            ],
            'Name' => '<string>',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members
Configurations
Type: Array of Configuration structures
MaxResults
Type: int
NextToken
Type: string

Errors

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListTags 

$result = $client->listTags([/* ... */]);
$promise = $client->listTagsAsync([/* ... */]);

Lists tags for a resource.

Parameter Syntax

$result = $client->listTags([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (__string) to strings

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

ListUsers 

$result = $client->listUsers([/* ... */]);
$promise = $client->listUsersAsync([/* ... */]);

Returns a list of all ActiveMQ users.

Parameter Syntax

$result = $client->listUsers([
    'BrokerId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string
MaxResults
Type: int
NextToken
Type: string

Result Syntax

[
    'BrokerId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Users' => [
        [
            'PendingChange' => 'CREATE|UPDATE|DELETE',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
BrokerId
Type: string
MaxResults
Type: int
NextToken
Type: string
Users
Type: Array of UserSummary structures

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

Promote 

$result = $client->promote([/* ... */]);
$promise = $client->promoteAsync([/* ... */]);

Promotes a data replication replica broker to the primary broker role.

Parameter Syntax

$result = $client->promote([
    'BrokerId' => '<string>', // REQUIRED
    'Mode' => 'SWITCHOVER|FAILOVER', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string
Mode
Required: Yes
Type: string

The Promote mode requested.

Result Syntax

[
    'BrokerId' => '<string>',
]

Result Details

Members
BrokerId
Type: string

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

RebootBroker 

$result = $client->rebootBroker([/* ... */]);
$promise = $client->rebootBrokerAsync([/* ... */]);

Reboots a broker. Note: This API is asynchronous.

Parameter Syntax

$result = $client->rebootBroker([
    'BrokerId' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

UpdateBroker 

$result = $client->updateBroker([/* ... */]);
$promise = $client->updateBrokerAsync([/* ... */]);

Adds a pending configuration change to a broker.

Parameter Syntax

$result = $client->updateBroker([
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerId' => '<string>', // REQUIRED
    'Configuration' => [
        'Id' => '<string>', // REQUIRED
        'Revision' => <integer>,
    ],
    'DataReplicationMode' => 'NONE|CRDR',
    'EngineVersion' => '<string>',
    'HostInstanceType' => '<string>',
    'LdapServerMetadata' => [
        'Hosts' => ['<string>', ...], // REQUIRED
        'RoleBase' => '<string>', // REQUIRED
        'RoleName' => '<string>',
        'RoleSearchMatching' => '<string>', // REQUIRED
        'RoleSearchSubtree' => true || false,
        'ServiceAccountPassword' => '<string>', // REQUIRED
        'ServiceAccountUsername' => '<string>', // REQUIRED
        'UserBase' => '<string>', // REQUIRED
        'UserRoleName' => '<string>',
        'UserSearchMatching' => '<string>', // REQUIRED
        'UserSearchSubtree' => true || false,
    ],
    'Logs' => [
        'Audit' => true || false,
        'General' => true || false,
    ],
    'MaintenanceWindowStartTime' => [
        'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY', // REQUIRED
        'TimeOfDay' => '<string>', // REQUIRED
        'TimeZone' => '<string>',
    ],
    'SecurityGroups' => ['<string>', ...],
]);

Parameter Details

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean
BrokerId
Required: Yes
Type: string
Configuration
Type: ConfigurationId structure

A list of information about the configuration.

DataReplicationMode
Type: string

Specifies whether a broker is a part of a data replication pair.

EngineVersion
Type: string
HostInstanceType
Type: string
LdapServerMetadata
Type: LdapServerMetadataInput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

Logs
Type: Logs structure

The list of information about logs to be enabled for the specified broker.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

SecurityGroups
Type: Array of strings

Result Syntax

[
    'AuthenticationStrategy' => 'SIMPLE|LDAP',
    'AutoMinorVersionUpgrade' => true || false,
    'BrokerId' => '<string>',
    'Configuration' => [
        'Id' => '<string>',
        'Revision' => <integer>,
    ],
    'DataReplicationMetadata' => [
        'DataReplicationCounterpart' => [
            'BrokerId' => '<string>',
            'Region' => '<string>',
        ],
        'DataReplicationRole' => '<string>',
    ],
    'DataReplicationMode' => 'NONE|CRDR',
    '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,
    ],
    'MaintenanceWindowStartTime' => [
        'DayOfWeek' => 'MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY|SUNDAY',
        'TimeOfDay' => '<string>',
        'TimeZone' => '<string>',
    ],
    'PendingDataReplicationMetadata' => [
        'DataReplicationCounterpart' => [
            'BrokerId' => '<string>',
            'Region' => '<string>',
        ],
        'DataReplicationRole' => '<string>',
    ],
    'PendingDataReplicationMode' => 'NONE|CRDR',
    'SecurityGroups' => ['<string>', ...],
]

Result Details

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean
BrokerId
Type: string
Configuration
Type: ConfigurationId structure

A list of information about the configuration.

DataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

DataReplicationMode
Type: string

Specifies whether a broker is a part of a data replication pair.

EngineVersion
Type: string
HostInstanceType
Type: string
LdapServerMetadata
Type: LdapServerMetadataOutput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Logs
Type: Logs structure

The list of information about logs to be enabled for the specified broker.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

PendingDataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

PendingDataReplicationMode
Type: string

Specifies whether a broker is a part of a data replication pair.

SecurityGroups
Type: Array of strings

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

UpdateConfiguration 

$result = $client->updateConfiguration([/* ... */]);
$promise = $client->updateConfigurationAsync([/* ... */]);

Updates the specified configuration.

Parameter Syntax

$result = $client->updateConfiguration([
    'ConfigurationId' => '<string>', // REQUIRED
    'Data' => '<string>', // REQUIRED
    'Description' => '<string>',
]);

Parameter Details

Members
ConfigurationId
Required: Yes
Type: string
Data
Required: Yes
Type: string
Description
Type: string

Result Syntax

[
    'Arn' => '<string>',
    'Created' => <DateTime>,
    'Id' => '<string>',
    'LatestRevision' => [
        'Created' => <DateTime>,
        'Description' => '<string>',
        'Revision' => <integer>,
    ],
    'Name' => '<string>',
    'Warnings' => [
        [
            'AttributeName' => '<string>',
            'ElementName' => '<string>',
            'Reason' => 'DISALLOWED_ELEMENT_REMOVED|DISALLOWED_ATTRIBUTE_REMOVED|INVALID_ATTRIBUTE_VALUE_REMOVED',
        ],
        // ...
    ],
]

Result Details

Members
Arn
Type: string
Created
Type: timestamp (string|DateTime or anything parsable by strtotime)
Id
Type: string
LatestRevision
Type: ConfigurationRevision structure

Returns information about the specified configuration revision.

Name
Type: string
Warnings
Type: Array of SanitizationWarning structures

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

UpdateUser 

$result = $client->updateUser([/* ... */]);
$promise = $client->updateUserAsync([/* ... */]);

Updates the information for an ActiveMQ user.

Parameter Syntax

$result = $client->updateUser([
    'BrokerId' => '<string>', // REQUIRED
    'ConsoleAccess' => true || false,
    'Groups' => ['<string>', ...],
    'Password' => '<string>',
    'ReplicationUser' => true || false,
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Members
BrokerId
Required: Yes
Type: string
ConsoleAccess
Type: boolean
Groups
Type: Array of strings
Password
Type: string
ReplicationUser
Type: boolean
Username
Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

Returns information about an error.

BadRequestException:

Returns information about an error.

InternalServerErrorException:

Returns information about an error.

ConflictException:

Returns information about an error.

ForbiddenException:

Returns information about an error.

Shapes

ActionRequired

Description

Action required for a broker.

Members
ActionRequiredCode
Type: string

The code you can use to find instructions on the action required to resolve your broker issue.

ActionRequiredInfo
Type: string

Information about the action required to resolve your broker issue.

AvailabilityZone

Description

Name of the availability zone.

Members
Name
Type: string

Id for the availability zone.

BadRequestException

Description

Returns information about an error.

Members
ErrorAttribute
Type: string
Message
Type: string

BrokerEngineType

Description

Types of broker engines.

Members
EngineType
Type: string

The broker's engine type.

EngineVersions
Type: Array of EngineVersion structures

The list of engine versions.

BrokerEngineTypeOutput

Description

Returns a list of broker engine type.

Members
BrokerEngineTypes
Type: Array of BrokerEngineType structures

List of available engine types and versions.

MaxResults
Required: Yes
Type: int

Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.

NextToken
Type: string

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

BrokerInstance

Description

Returns information about all brokers.

Members
ConsoleURL
Type: string

The brokers web console URL.

Endpoints
Type: Array of strings

The broker's wire-level protocol endpoints.

IpAddress
Type: string

The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.

BrokerInstanceOption

Description

Option for host instance type.

Members
AvailabilityZones
Type: Array of AvailabilityZone structures

The list of available az.

EngineType
Type: string

The broker's engine type.

HostInstanceType
Type: string

The broker's instance type.

StorageType
Type: string

The broker's storage type.

SupportedDeploymentModes
Type: Array of strings

The list of supported deployment modes.

SupportedEngineVersions
Type: Array of strings

The list of supported engine versions.

BrokerInstanceOptionsOutput

Description

Returns a list of broker instance options.

Members
BrokerInstanceOptions
Type: Array of BrokerInstanceOption structures

List of available broker instance options.

MaxResults
Required: Yes
Type: int

Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.

NextToken
Type: string

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

BrokerSummary

Description

Returns information about all brokers.

Members
BrokerArn
Type: string

The broker's Amazon Resource Name (ARN).

BrokerId
Type: string

The unique ID that Amazon MQ generates for the broker.

BrokerName
Type: string

The broker's name. This value is unique in your Amazon Web Services account, 1-50 characters long, and containing only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

BrokerState
Type: string

The broker's status.

Created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the broker was created.

DeploymentMode
Required: Yes
Type: string

The broker's deployment mode.

EngineType
Required: Yes
Type: string

The type of broker engine.

HostInstanceType
Type: string

The broker's instance type.

Configuration

Description

Returns information about all configurations.

Members
Arn
Required: Yes
Type: string

Required. The ARN of the configuration.

AuthenticationStrategy
Required: Yes
Type: string

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

Created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Required. The date and time of the configuration revision.

Description
Required: Yes
Type: string

Required. The description of the configuration.

EngineType
Required: Yes
Type: string

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

EngineVersion
Required: Yes
Type: string

The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

Id
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the configuration.

LatestRevision
Required: Yes
Type: ConfigurationRevision structure

Required. The latest revision of the configuration.

Name
Required: Yes
Type: 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
Type: Associative array of custom strings keys (__string) to strings

The list of all tags associated with this configuration.

ConfigurationId

Description

A list of information about the configuration.

Members
Id
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the configuration.

Revision
Type: int

The revision number of the configuration.

ConfigurationRevision

Description

Returns information about the specified configuration revision.

Members
Created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Required. The date and time of the configuration revision.

Description
Type: string

The description of the configuration revision.

Revision
Required: Yes
Type: int

Required. The revision number of the configuration.

Configurations

Description

Broker configuration information

Members
Current
Type: ConfigurationId structure

The broker's current configuration.

History
Type: Array of ConfigurationId structures

The history of configurations applied to the broker.

Pending
Type: ConfigurationId structure

The broker's pending configuration.

ConflictException

Description

Returns information about an error.

Members
ErrorAttribute
Type: string
Message
Type: string

CreateBrokerInput

Description

Creates a broker.

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

BrokerName
Required: Yes
Type: string

Required. The broker's name. This value must be unique in your Amazon Web Services account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker names are not intended to be used for private or sensitive data.

Configuration
Type: ConfigurationId structure

A list of information about the configuration.

CreatorRequestId
Type: string

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.

We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.

DataReplicationMode
Type: string

Defines whether this broker is a part of a data replication pair.

DataReplicationPrimaryBrokerArn
Type: string

The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when dataReplicationMode is set to CRDR.

DeploymentMode
Required: Yes
Type: string

Required. The broker's deployment mode.

EncryptionOptions
Type: EncryptionOptions structure

Encryption options for the broker.

EngineType
Required: Yes
Type: string

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

EngineVersion
Type: string

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

HostInstanceType
Required: Yes
Type: string

Required. The broker's instance type.

LdapServerMetadata
Type: LdapServerMetadataInput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Logs
Type: Logs structure

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The parameters that determine the WeeklyStartTime.

PubliclyAccessible
Required: Yes
Type: boolean

Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

SecurityGroups
Type: Array of strings

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

StorageType
Type: string

The broker's storage type.

SubnetIds
Type: Array of strings

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.

If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your Amazon Web Services account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your Amazon Web Services account.

Tags
Type: Associative array of custom strings keys (__string) to strings

Create tags when creating the broker.

Users
Required: Yes
Type: Array of User structures

The list of broker users (persons or applications) who can access queues and topics. 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.

CreateBrokerOutput

Description

Returns information about the created broker.

Members
BrokerArn
Type: string

The broker's Amazon Resource Name (ARN).

BrokerId
Type: string

The unique ID that Amazon MQ generates for the broker.

CreateConfigurationInput

Description

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

EngineType
Required: Yes
Type: string

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

EngineVersion
Type: string

The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

Name
Required: Yes
Type: 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
Type: Associative array of custom strings keys (__string) to strings

Create tags when creating the configuration.

CreateConfigurationOutput

Description

Returns information about the created configuration.

Members
Arn
Required: Yes
Type: string

Required. The Amazon Resource Name (ARN) of the configuration.

AuthenticationStrategy
Required: Yes
Type: string

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

Created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Required. The date and time of the configuration.

Id
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the configuration.

LatestRevision
Type: ConfigurationRevision structure

The latest revision of the configuration.

Name
Required: Yes
Type: 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.

CreateUserInput

Description

Creates a new ActiveMQ user.

Members
ConsoleAccess
Type: boolean

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

Groups
Type: Array of strings

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.

Password
Required: Yes
Type: string

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

ReplicationUser
Type: boolean

Defines if this user is intended for CRDR replication purposes.

DataReplicationCounterpart

Description

Specifies a broker in a data replication pair.

Members
BrokerId
Required: Yes
Type: string

Required. The unique broker id generated by Amazon MQ.

Region
Required: Yes
Type: string

Required. The region of the broker.

DataReplicationMetadataOutput

Description

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.

Members
DataReplicationCounterpart
Type: DataReplicationCounterpart structure

Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker's dataReplicationRole property.

DataReplicationRole
Required: Yes
Type: string

Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.

DeleteBrokerOutput

Description

Returns information about the deleted broker.

Members
BrokerId
Type: string

The unique ID that Amazon MQ generates for the broker.

DescribeBrokerOutput

Description

Returns information about the specified broker.

Members
ActionsRequired
Type: Array of ActionRequired structures

Actions required for a broker.

AuthenticationStrategy
Type: string

The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Required: Yes
Type: boolean

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

BrokerArn
Type: string

The broker's Amazon Resource Name (ARN).

BrokerId
Type: string

The unique ID that Amazon MQ generates for the broker.

BrokerInstances
Type: Array of BrokerInstance structures

A list of information about allocated brokers.

BrokerName
Type: string

The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

BrokerState
Type: string

The broker's status.

Configurations
Type: Configurations structure

The list of all revisions for the specified configuration.

Created
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the broker was created.

DataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

DataReplicationMode
Type: string

Describes whether this broker is a part of a data replication pair.

DeploymentMode
Required: Yes
Type: string

The broker's deployment mode.

EncryptionOptions
Type: EncryptionOptions structure

Encryption options for the broker.

EngineType
Required: Yes
Type: string

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

EngineVersion
Type: string

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

HostInstanceType
Type: string

The broker's instance type.

LdapServerMetadata
Type: LdapServerMetadataOutput structure

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Logs
Type: LogsSummary structure

The list of information about logs currently enabled and pending to be deployed for the specified broker.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The parameters that determine the WeeklyStartTime.

PendingAuthenticationStrategy
Type: string

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

PendingDataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

PendingDataReplicationMode
Type: string

Describes whether this broker will be a part of a data replication pair after reboot.

PendingEngineVersion
Type: string

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

PendingHostInstanceType
Type: string

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

PendingLdapServerMetadata
Type: LdapServerMetadataOutput structure

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

PendingSecurityGroups
Type: Array of strings

The list of pending security groups to authorize connections to brokers.

PubliclyAccessible
Required: Yes
Type: boolean

Enables connections from applications outside of the VPC that hosts the broker's subnets.

SecurityGroups
Type: Array of strings

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

StorageType
Type: string

The broker's storage type.

SubnetIds
Type: Array of strings

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

Tags
Type: Associative array of custom strings keys (__string) to strings

The list of all tags associated with this broker.

Users
Type: Array of UserSummary structures

The list of all broker usernames for the specified broker.

DescribeConfigurationRevisionOutput

Description

Returns the specified configuration revision for the specified configuration.

Members
ConfigurationId
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the configuration.

Created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Required. The date and time of the configuration.

Data
Required: Yes
Type: string

Amazon MQ for ActiveMQ: the base64-encoded XML configuration. Amazon MQ for RabbitMQ: base64-encoded Cuttlefish.

Description
Type: string

The description of the configuration.

DescribeUserOutput

Description

Returns information about an ActiveMQ user.

Members
BrokerId
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the broker.

ConsoleAccess
Type: boolean

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

Groups
Type: Array of strings

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.

Pending
Type: UserPendingChanges structure

The status of the changes pending for the ActiveMQ user.

ReplicationUser
Type: boolean

Describes whether the user is intended for data replication

Username
Required: Yes
Type: 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.

EncryptionOptions

Description

Encryption options for the broker.

Members
KmsKeyId
Type: string

The customer master key (CMK) to use for the A KMS (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
Required: Yes
Type: boolean

Enables the use of an Amazon Web Services owned CMK using KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.

EngineVersion

Description

Id of the engine version.

Members
Name
Type: string

Id for the version.

Error

Description

Returns information about an error.

Members
ErrorAttribute
Type: string

The attribute which caused the error.

Message
Type: string

The explanation of the error.

ForbiddenException

Description

Returns information about an error.

Members
ErrorAttribute
Type: string
Message
Type: string

InternalServerErrorException

Description

Returns information about an error.

Members
ErrorAttribute
Type: string
Message
Type: string

LdapServerMetadataInput

Description

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Does not apply to RabbitMQ brokers.

Members
Hosts
Required: Yes
Type: Array of strings

Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

RoleBase
Required: Yes
Type: string

The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.

RoleName
Type: string

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

RoleSearchMatching
Required: Yes
Type: string

The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

RoleSearchSubtree
Type: boolean

The directory search scope for the role. If set to true, scope is to search the entire subtree.

ServiceAccountPassword
Required: Yes
Type: string

Service account password. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.

ServiceAccountUsername
Required: Yes
Type: string

Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.

UserBase
Required: Yes
Type: string

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.

UserRoleName
Type: string

Specifies the name of the LDAP attribute for the user group membership.

UserSearchMatching
Required: Yes
Type: string

The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

UserSearchSubtree
Type: boolean

The directory search scope for the user. If set to true, scope is to search the entire subtree.

LdapServerMetadataOutput

Description

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.

Members
Hosts
Required: Yes
Type: Array of strings

Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.

RoleBase
Required: Yes
Type: string

The distinguished name of the node in the directory information tree (DIT) to search for roles or groups. For example, ou=group, ou=corp, dc=corp, dc=example, dc=com.

RoleName
Type: string

Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.

RoleSearchMatching
Required: Yes
Type: string

The LDAP search filter used to find roles within the roleBase. The distinguished name of the user matched by userSearchMatching is substituted into the {0} placeholder in the search filter. The client's username is substituted into the {1} placeholder. For example, if you set this option to (member=uid={1})for the user janedoe, the search filter becomes (member=uid=janedoe) after string substitution. It matches all role entries that have a member attribute equal to uid=janedoe under the subtree selected by the roleBase.

RoleSearchSubtree
Type: boolean

The directory search scope for the role. If set to true, scope is to search the entire subtree.

ServiceAccountUsername
Required: Yes
Type: string

Service account username. A service account is an account in your LDAP server that has access to initiate a connection. For example, cn=admin,dc=corp, dc=example, dc=com.

UserBase
Required: Yes
Type: string

Select a particular subtree of the directory information tree (DIT) to search for user entries. The subtree is specified by a DN, which specifies the base node of the subtree. For example, by setting this option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for user entries is restricted to the subtree beneath ou=Users, ou=corp, dc=corp, dc=example, dc=com.

UserRoleName
Type: string

Specifies the name of the LDAP attribute for the user group membership.

UserSearchMatching
Required: Yes
Type: string

The LDAP search filter used to find users within the userBase. The client's username is substituted into the {0} placeholder in the search filter. For example, if this option is set to (uid={0}) and the received username is janedoe, the search filter becomes (uid=janedoe) after string substitution. It will result in matching an entry like uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.

UserSearchSubtree
Type: boolean

The directory search scope for the user. If set to true, scope is to search the entire subtree.

ListBrokersOutput

Description

A list of information about all brokers.

Members
BrokerSummaries
Type: Array of BrokerSummary structures

A list of information about all brokers.

NextToken
Type: string

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListConfigurationRevisionsOutput

Description

Returns a list of all revisions for the specified configuration.

Members
ConfigurationId
Type: string

The unique ID that Amazon MQ generates for the configuration.

MaxResults
Type: int

The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.

NextToken
Type: string

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Revisions
Type: Array of ConfigurationRevision structures

The list of all revisions for the specified configuration.

ListConfigurationsOutput

Description

Returns a list of all configurations.

Members
Configurations
Type: Array of Configuration structures

The list of all revisions for the specified configuration.

MaxResults
Type: int

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
Type: string

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListUsersOutput

Description

Returns a list of all ActiveMQ users.

Members
BrokerId
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the broker.

MaxResults
Required: Yes
Type: int

Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.

NextToken
Type: string

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

Users
Required: Yes
Type: Array of UserSummary structures

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

Logs

Description

The list of information about logs to be enabled for the specified broker.

Members
Audit
Type: boolean

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.

General
Type: boolean

Enables general logging.

LogsSummary

Description

The list of information about logs currently enabled and pending to be deployed for the specified broker.

Members
Audit
Type: boolean

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

AuditLogGroup
Type: string

The location of the CloudWatch Logs log group where audit logs are sent.

General
Required: Yes
Type: boolean

Enables general logging.

GeneralLogGroup
Required: Yes
Type: string

The location of the CloudWatch Logs log group where general logs are sent.

Pending
Type: PendingLogs structure

The list of information about logs pending to be deployed for the specified broker.

NotFoundException

Description

Returns information about an error.

Members
ErrorAttribute
Type: string
Message
Type: string

PendingLogs

Description

The list of information about logs to be enabled for the specified broker.

Members
Audit
Type: boolean

Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.

General
Type: boolean

Enables general logging.

PromoteInput

Description

Creates a Promote request with the properties specified.

Members
Mode
Required: Yes
Type: string

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

PromoteOutput

Description

Returns information about the updated broker.

Members
BrokerId
Type: string

The unique ID that Amazon MQ generates for the broker.

SanitizationWarning

Description

Returns information about the configuration element or attribute that was sanitized in the configuration.

Members
AttributeName
Type: string

The name of the configuration attribute that has been sanitized.

ElementName
Type: string

The name of the configuration element that has been sanitized.

Reason
Required: Yes
Type: string

The reason for which the configuration elements or attributes were sanitized.

Tags

Description

A map of the key-value pairs for the resource tag.

Members
Tags
Type: Associative array of custom strings keys (__string) to strings

The key-value pair for the resource tag.

UnauthorizedException

Description

Returns information about an error.

Members
ErrorAttribute
Type: string
Message
Type: string

UpdateBrokerInput

Description

Updates the broker using the specified properties.

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.

Configuration
Type: ConfigurationId structure

A list of information about the configuration.

DataReplicationMode
Type: string

Defines whether this broker is a part of a data replication pair.

EngineVersion
Type: string

The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.

HostInstanceType
Type: string

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

LdapServerMetadata
Type: LdapServerMetadataInput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Logs
Type: Logs structure

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The parameters that determine the WeeklyStartTime.

SecurityGroups
Type: Array of strings

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

UpdateBrokerOutput

Description

Returns information about the updated broker.

Members
AuthenticationStrategy
Type: string

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

AutoMinorVersionUpgrade
Type: boolean

Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.

BrokerId
Required: Yes
Type: string

Required. The unique ID that Amazon MQ generates for the broker.

Configuration
Type: ConfigurationId structure

The ID of the updated configuration.

DataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

DataReplicationMode
Type: string

Describes whether this broker is a part of a data replication pair.

EngineVersion
Type: string

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

HostInstanceType
Type: string

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

LdapServerMetadata
Type: LdapServerMetadataOutput structure

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

Logs
Type: Logs structure

The list of information about logs to be enabled for the specified broker.

MaintenanceWindowStartTime
Type: WeeklyStartTime structure

The parameters that determine the WeeklyStartTime.

PendingDataReplicationMetadata
Type: DataReplicationMetadataOutput structure

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

PendingDataReplicationMode
Type: string

Describes whether this broker will be a part of a data replication pair after reboot.

SecurityGroups
Type: Array of strings

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

UpdateConfigurationInput

Description

Updates the specified configuration.

Members
Data
Required: Yes
Type: string

Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.

Description
Type: string

The description of the configuration.

UpdateConfigurationOutput

Description

Returns information about the updated configuration.

Members
Arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the configuration.

Created
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Required. The date and time of the configuration.

Id
Required: Yes
Type: string

The unique ID that Amazon MQ generates for the configuration.

LatestRevision
Type: ConfigurationRevision structure

The latest revision of the configuration.

Name
Required: Yes
Type: string

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.

Warnings
Type: Array of SanitizationWarning structures

The list of the first 20 warnings about the configuration elements or attributes that were sanitized.

UpdateUserInput

Description

Updates the information for an ActiveMQ user.

Members
ConsoleAccess
Type: boolean

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

Groups
Type: Array of strings

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.

Password
Type: string

The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

ReplicationUser
Type: boolean

Defines whether the user is intended for data replication.

User

Description

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.

Members
ConsoleAccess
Type: boolean

Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.

Groups
Type: Array of strings

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. Does not apply to RabbitMQ brokers.

Password
Required: Yes
Type: string

Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).

ReplicationUser
Type: boolean

Defines if this user is intended for CRDR replication purposes.

Username
Required: Yes
Type: string

The username of the broker user. The following restrictions apply to broker usernames:

  • For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

  • para>For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.

Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

UserPendingChanges

Description

Returns information about the status of the changes pending for the ActiveMQ user.

Members
ConsoleAccess
Type: boolean

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

Groups
Type: Array of strings

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.

PendingChange
Required: Yes
Type: string

Required. The type of change pending for the ActiveMQ user.

UserSummary

Description

Returns a list of all broker users. Does not apply to RabbitMQ brokers.

Members
PendingChange
Type: string

The type of change pending for the broker user.

Username
Required: Yes
Type: string

Required. The username of the broker user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

WeeklyStartTime

Description

The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

Members
DayOfWeek
Required: Yes
Type: string

Required. The day of the week.

TimeOfDay
Required: Yes
Type: string

Required. The time, in 24-hour format.

TimeZone
Type: string

The time zone, UTC by default, in either the Country/City format, or the UTC offset format.