Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
', 'operations' => [ 'CreateBroker' => '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.
', 'CreateConfiguration' => 'Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
', 'CreateTags' => 'Add a tag to a resource.
', 'CreateUser' => '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.
Deletes a broker. Note: This API is asynchronous.
', 'DeleteTags' => 'Removes a tag from a resource.
', 'DeleteUser' => 'Deletes an ActiveMQ user.
', 'DescribeBroker' => 'Returns information about the specified broker.
', 'DescribeBrokerEngineTypes' => 'Describe available engine types and versions.
', 'DescribeBrokerInstanceOptions' => 'Describe available broker instance options.
', 'DescribeConfiguration' => 'Returns information about the specified configuration.
', 'DescribeConfigurationRevision' => 'Returns the specified configuration revision for the specified configuration.
', 'DescribeUser' => 'Returns information about an ActiveMQ user.
', 'ListBrokers' => 'Returns a list of all brokers.
', 'ListConfigurationRevisions' => 'Returns a list of all revisions for the specified configuration.
', 'ListConfigurations' => 'Returns a list of all configurations.
', 'ListTags' => 'Lists tags for a resource.
', 'ListUsers' => 'Returns a list of all ActiveMQ users.
', 'Promote' => 'Promotes a data replication replica broker to the primary broker role.
', 'RebootBroker' => 'Reboots a broker. Note: This API is asynchronous.
', 'UpdateBroker' => 'Adds a pending configuration change to a broker.
', 'UpdateConfiguration' => 'Updates the specified configuration.
', 'UpdateUser' => 'Updates the information for an ActiveMQ user.
', ], 'shapes' => [ 'ActionRequired' => [ 'base' => 'Action required for a broker.
', 'refs' => [ '__listOfActionRequired$member' => NULL, ], ], 'AuthenticationStrategy' => [ 'base' => 'Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
', 'refs' => [ 'Configuration$AuthenticationStrategy' => 'Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
', 'CreateBrokerInput$AuthenticationStrategy' => 'Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
', 'CreateConfigurationInput$AuthenticationStrategy' => 'Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
', 'CreateConfigurationOutput$AuthenticationStrategy' => 'Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
', 'DescribeBrokerOutput$AuthenticationStrategy' => 'The authentication strategy used to secure the broker. The default is SIMPLE.
', 'DescribeBrokerOutput$PendingAuthenticationStrategy' => 'The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
', 'UpdateBrokerInput$AuthenticationStrategy' => 'Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
', 'UpdateBrokerOutput$AuthenticationStrategy' => 'Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
', ], ], 'AvailabilityZone' => [ 'base' => 'Name of the availability zone.
', 'refs' => [ '__listOfAvailabilityZone$member' => NULL, ], ], 'BadRequestException' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'BrokerEngineType' => [ 'base' => 'Types of broker engines.
', 'refs' => [ '__listOfBrokerEngineType$member' => NULL, ], ], 'BrokerEngineTypeOutput' => [ 'base' => 'Returns a list of broker engine type.
', 'refs' => [], ], 'BrokerInstance' => [ 'base' => 'Returns information about all brokers.
', 'refs' => [ '__listOfBrokerInstance$member' => NULL, ], ], 'BrokerInstanceOption' => [ 'base' => 'Option for host instance type.
', 'refs' => [ '__listOfBrokerInstanceOption$member' => NULL, ], ], 'BrokerInstanceOptionsOutput' => [ 'base' => 'Returns a list of broker instance options.
', 'refs' => [], ], 'BrokerState' => [ 'base' => 'The broker\'s status.
', 'refs' => [ 'BrokerSummary$BrokerState' => 'The broker\'s status.
', 'DescribeBrokerOutput$BrokerState' => 'The broker\'s status.
', ], ], 'BrokerStorageType' => [ 'base' => 'The broker\'s storage type.
EFS is not supported for RabbitMQ engine type.
The broker\'s storage type.
', 'CreateBrokerInput$StorageType' => 'The broker\'s storage type.
', 'DescribeBrokerOutput$StorageType' => 'The broker\'s storage type.
', ], ], 'BrokerSummary' => [ 'base' => 'Returns information about all brokers.
', 'refs' => [ '__listOfBrokerSummary$member' => NULL, ], ], 'ChangeType' => [ 'base' => 'The type of change pending for the ActiveMQ user.
', 'refs' => [ 'UserPendingChanges$PendingChange' => 'Required. The type of change pending for the ActiveMQ user.
', 'UserSummary$PendingChange' => 'The type of change pending for the broker user.
', ], ], 'Configuration' => [ 'base' => 'Returns information about all configurations.
', 'refs' => [ '__listOfConfiguration$member' => NULL, ], ], 'ConfigurationId' => [ 'base' => 'A list of information about the configuration.
', 'refs' => [ 'Configurations$Current' => 'The broker\'s current configuration.
', 'Configurations$Pending' => 'The broker\'s pending configuration.
', 'CreateBrokerInput$Configuration' => 'A list of information about the configuration.
', 'UpdateBrokerInput$Configuration' => 'A list of information about the configuration.
', 'UpdateBrokerOutput$Configuration' => 'The ID of the updated configuration.
', '__listOfConfigurationId$member' => NULL, ], ], 'ConfigurationRevision' => [ 'base' => 'Returns information about the specified configuration revision.
', 'refs' => [ 'Configuration$LatestRevision' => 'Required. The latest revision of the configuration.
', 'CreateConfigurationOutput$LatestRevision' => 'The latest revision of the configuration.
', 'UpdateConfigurationOutput$LatestRevision' => 'The latest revision of the configuration.
', '__listOfConfigurationRevision$member' => NULL, ], ], 'Configurations' => [ 'base' => 'Broker configuration information
', 'refs' => [ 'DescribeBrokerOutput$Configurations' => 'The list of all revisions for the specified configuration.
', ], ], 'ConflictException' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'CreateBrokerInput' => [ 'base' => 'Creates a broker.
', 'refs' => [], ], 'CreateBrokerOutput' => [ 'base' => 'Returns information about the created broker.
', 'refs' => [], ], 'CreateConfigurationInput' => [ 'base' => 'Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
', 'refs' => [], ], 'CreateConfigurationOutput' => [ 'base' => 'Returns information about the created configuration.
', 'refs' => [], ], 'CreateUserInput' => [ 'base' => 'Creates a new ActiveMQ user.
', 'refs' => [], ], 'DataReplicationCounterpart' => [ 'base' => 'Specifies a broker in a data replication pair.
', 'refs' => [ 'DataReplicationMetadataOutput$DataReplicationCounterpart' => 'Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker\'s dataReplicationRole property.
', ], ], 'DataReplicationMetadataOutput' => [ 'base' => 'The replication details of the data replication-enabled broker. Only returned if dataReplicationMode or pendingDataReplicationMode is set to CRDR.
', 'refs' => [ 'DescribeBrokerOutput$DataReplicationMetadata' => 'The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
', 'DescribeBrokerOutput$PendingDataReplicationMetadata' => 'The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
', 'UpdateBrokerOutput$DataReplicationMetadata' => 'The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
', 'UpdateBrokerOutput$PendingDataReplicationMetadata' => 'The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
', ], ], 'DataReplicationMode' => [ 'base' => 'Specifies whether a broker is a part of a data replication pair.
', 'refs' => [ 'CreateBrokerInput$DataReplicationMode' => 'Defines whether this broker is a part of a data replication pair.
', 'DescribeBrokerOutput$DataReplicationMode' => 'Describes whether this broker is a part of a data replication pair.
', 'DescribeBrokerOutput$PendingDataReplicationMode' => 'Describes whether this broker will be a part of a data replication pair after reboot.
', 'UpdateBrokerInput$DataReplicationMode' => 'Defines whether this broker is a part of a data replication pair.
', 'UpdateBrokerOutput$DataReplicationMode' => 'Describes whether this broker is a part of a data replication pair.
', 'UpdateBrokerOutput$PendingDataReplicationMode' => 'Describes whether this broker will be a part of a data replication pair after reboot.
', ], ], 'DayOfWeek' => [ 'base' => NULL, 'refs' => [ 'WeeklyStartTime$DayOfWeek' => 'Required. The day of the week.
', ], ], 'DeleteBrokerOutput' => [ 'base' => 'Returns information about the deleted broker.
', 'refs' => [], ], 'DeploymentMode' => [ 'base' => 'The broker\'s deployment mode.
', 'refs' => [ 'BrokerSummary$DeploymentMode' => 'The broker\'s deployment mode.
', 'CreateBrokerInput$DeploymentMode' => 'Required. The broker\'s deployment mode.
', 'DescribeBrokerOutput$DeploymentMode' => 'The broker\'s deployment mode.
', '__listOfDeploymentMode$member' => NULL, ], ], 'DescribeBrokerOutput' => [ 'base' => 'Returns information about the specified broker.
', 'refs' => [], ], 'DescribeConfigurationRevisionOutput' => [ 'base' => 'Returns the specified configuration revision for the specified configuration.
', 'refs' => [], ], 'DescribeUserOutput' => [ 'base' => 'Returns information about an ActiveMQ user.
', 'refs' => [], ], 'EncryptionOptions' => [ 'base' => 'Encryption options for the broker.
', 'refs' => [ 'CreateBrokerInput$EncryptionOptions' => 'Encryption options for the broker.
', 'DescribeBrokerOutput$EncryptionOptions' => 'Encryption options for the broker.
', ], ], 'EngineType' => [ 'base' => 'The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
', 'refs' => [ 'BrokerEngineType$EngineType' => 'The broker\'s engine type.
', 'BrokerInstanceOption$EngineType' => 'The broker\'s engine type.
', 'BrokerSummary$EngineType' => 'The type of broker engine.
', 'Configuration$EngineType' => 'Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
', 'CreateBrokerInput$EngineType' => 'Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
', 'CreateConfigurationInput$EngineType' => 'Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
', 'DescribeBrokerOutput$EngineType' => 'The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
', ], ], 'EngineVersion' => [ 'base' => 'Id of the engine version.
', 'refs' => [ '__listOfEngineVersion$member' => NULL, ], ], 'Error' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'ForbiddenException' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'InternalServerErrorException' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'LdapServerMetadataInput' => [ 'base' => 'Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Does not apply to RabbitMQ brokers.
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
', 'UpdateBrokerInput$LdapServerMetadata' => 'Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
', ], ], 'LdapServerMetadataOutput' => [ 'base' => 'Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
', 'refs' => [ 'DescribeBrokerOutput$LdapServerMetadata' => 'The metadata of the LDAP server used to authenticate and authorize connections to the broker.
', 'DescribeBrokerOutput$PendingLdapServerMetadata' => 'The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
', 'UpdateBrokerOutput$LdapServerMetadata' => 'Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
', ], ], 'ListBrokersOutput' => [ 'base' => 'A list of information about all brokers.
', 'refs' => [], ], 'ListConfigurationRevisionsOutput' => [ 'base' => 'Returns a list of all revisions for the specified configuration.
', 'refs' => [], ], 'ListConfigurationsOutput' => [ 'base' => 'Returns a list of all configurations.
', 'refs' => [], ], 'ListUsersOutput' => [ 'base' => 'Returns a list of all ActiveMQ users.
', 'refs' => [], ], 'Logs' => [ 'base' => 'The list of information about logs to be enabled for the specified broker.
', 'refs' => [ 'CreateBrokerInput$Logs' => 'Enables Amazon CloudWatch logging for brokers.
', 'UpdateBrokerInput$Logs' => 'Enables Amazon CloudWatch logging for brokers.
', 'UpdateBrokerOutput$Logs' => 'The list of information about logs to be enabled for the specified broker.
', ], ], 'LogsSummary' => [ 'base' => 'The list of information about logs currently enabled and pending to be deployed for the specified broker.
', 'refs' => [ 'DescribeBrokerOutput$Logs' => 'The list of information about logs currently enabled and pending to be deployed for the specified broker.
', ], ], 'NotFoundException' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'PendingLogs' => [ 'base' => 'The list of information about logs to be enabled for the specified broker.
', 'refs' => [ 'LogsSummary$Pending' => 'The list of information about logs pending to be deployed for the specified broker.
', ], ], 'PromoteInput' => [ 'base' => 'Creates a Promote request with the properties specified.
', 'refs' => [], ], 'PromoteMode' => [ 'base' => 'The Promote mode requested.
', 'refs' => [ 'PromoteInput$Mode' => 'The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.
', ], ], 'PromoteOutput' => [ 'base' => 'Returns information about the updated broker.
', 'refs' => [], ], 'SanitizationWarning' => [ 'base' => 'Returns information about the configuration element or attribute that was sanitized in the configuration.
', 'refs' => [ '__listOfSanitizationWarning$member' => NULL, ], ], 'SanitizationWarningReason' => [ 'base' => 'The reason for which the configuration elements or attributes were sanitized.
', 'refs' => [ 'SanitizationWarning$Reason' => 'The reason for which the configuration elements or attributes were sanitized.
', ], ], 'Tags' => [ 'base' => 'A map of the key-value pairs for the resource tag.
', 'refs' => [], ], 'UnauthorizedException' => [ 'base' => 'Returns information about an error.
', 'refs' => [], ], 'UpdateBrokerInput' => [ 'base' => 'Updates the broker using the specified properties.
', 'refs' => [], ], 'UpdateBrokerOutput' => [ 'base' => 'Returns information about the updated broker.
', 'refs' => [], ], 'UpdateConfigurationInput' => [ 'base' => 'Updates the specified configuration.
', 'refs' => [], ], 'UpdateConfigurationOutput' => [ 'base' => 'Returns information about the updated configuration.
', 'refs' => [], ], 'UpdateUserInput' => [ 'base' => 'Updates the information for an ActiveMQ user.
', 'refs' => [], ], 'User' => [ 'base' => '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.
', 'refs' => [ '__listOfUser$member' => NULL, ], ], 'UserPendingChanges' => [ 'base' => 'Returns information about the status of the changes pending for the ActiveMQ user.
', 'refs' => [ 'DescribeUserOutput$Pending' => 'The status of the changes pending for the ActiveMQ user.
', ], ], 'UserSummary' => [ 'base' => 'Returns a list of all broker users. Does not apply to RabbitMQ brokers.
', 'refs' => [ '__listOfUserSummary$member' => NULL, ], ], 'WeeklyStartTime' => [ 'base' => 'The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
', 'refs' => [ 'CreateBrokerInput$MaintenanceWindowStartTime' => 'The parameters that determine the WeeklyStartTime.
', 'DescribeBrokerOutput$MaintenanceWindowStartTime' => 'The parameters that determine the WeeklyStartTime.
', 'UpdateBrokerInput$MaintenanceWindowStartTime' => 'The parameters that determine the WeeklyStartTime.
', 'UpdateBrokerOutput$MaintenanceWindowStartTime' => 'The parameters that determine the WeeklyStartTime.
', ], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'CreateBrokerInput$AutoMinorVersionUpgrade' => 'Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
', 'CreateBrokerInput$PubliclyAccessible' => 'Enables connections from applications outside of the VPC that hosts the broker\'s subnets. Set to false by default, if no value is provided.
', 'CreateUserInput$ConsoleAccess' => 'Enables access to the ActiveMQ Web Console for the ActiveMQ user.
', 'CreateUserInput$ReplicationUser' => 'Defines if this user is intended for CRDR replication purposes.
', 'DescribeBrokerOutput$AutoMinorVersionUpgrade' => 'Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
', 'DescribeBrokerOutput$PubliclyAccessible' => 'Enables connections from applications outside of the VPC that hosts the broker\'s subnets.
', 'DescribeUserOutput$ConsoleAccess' => 'Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
', 'DescribeUserOutput$ReplicationUser' => 'Describes whether the user is intended for data replication
', 'EncryptionOptions$UseAwsOwnedKey' => '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.
', 'LdapServerMetadataInput$RoleSearchSubtree' => 'The directory search scope for the role. If set to true, scope is to search the entire subtree.
', 'LdapServerMetadataInput$UserSearchSubtree' => 'The directory search scope for the user. If set to true, scope is to search the entire subtree.
', 'LdapServerMetadataOutput$RoleSearchSubtree' => 'The directory search scope for the role. If set to true, scope is to search the entire subtree.
', 'LdapServerMetadataOutput$UserSearchSubtree' => 'The directory search scope for the user. If set to true, scope is to search the entire subtree.
', 'Logs$Audit' => 'Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
', 'Logs$General' => 'Enables general logging.
', 'LogsSummary$Audit' => 'Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
', 'LogsSummary$General' => 'Enables general logging.
', 'PendingLogs$Audit' => 'Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
', 'PendingLogs$General' => 'Enables general logging.
', 'UpdateBrokerInput$AutoMinorVersionUpgrade' => 'Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
', 'UpdateBrokerOutput$AutoMinorVersionUpgrade' => 'The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.
', 'UpdateUserInput$ConsoleAccess' => 'Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
', 'UpdateUserInput$ReplicationUser' => 'Defines whether the user is intended for data replication.
', 'User$ConsoleAccess' => 'Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
', 'User$ReplicationUser' => 'Defines if this user is intended for CRDR replication purposes.
', 'UserPendingChanges$ConsoleAccess' => 'Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'ConfigurationId$Revision' => 'The revision number of the configuration.
', 'ConfigurationRevision$Revision' => 'Required. The revision number of the configuration.
', 'ListConfigurationRevisionsOutput$MaxResults' => '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.
', 'ListConfigurationsOutput$MaxResults' => '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.
', ], ], '__integerMin5Max100' => [ 'base' => NULL, 'refs' => [ 'BrokerEngineTypeOutput$MaxResults' => '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.
', 'BrokerInstanceOptionsOutput$MaxResults' => '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.
', 'ListUsersOutput$MaxResults' => '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.
', ], ], '__listOfActionRequired' => [ 'base' => NULL, 'refs' => [ 'DescribeBrokerOutput$ActionsRequired' => 'Actions required for a broker.
', ], ], '__listOfAvailabilityZone' => [ 'base' => NULL, 'refs' => [ 'BrokerInstanceOption$AvailabilityZones' => 'The list of available az.
', ], ], '__listOfBrokerEngineType' => [ 'base' => NULL, 'refs' => [ 'BrokerEngineTypeOutput$BrokerEngineTypes' => 'List of available engine types and versions.
', ], ], '__listOfBrokerInstance' => [ 'base' => NULL, 'refs' => [ 'DescribeBrokerOutput$BrokerInstances' => 'A list of information about allocated brokers.
', ], ], '__listOfBrokerInstanceOption' => [ 'base' => NULL, 'refs' => [ 'BrokerInstanceOptionsOutput$BrokerInstanceOptions' => 'List of available broker instance options.
', ], ], '__listOfBrokerSummary' => [ 'base' => NULL, 'refs' => [ 'ListBrokersOutput$BrokerSummaries' => 'A list of information about all brokers.
', ], ], '__listOfConfiguration' => [ 'base' => NULL, 'refs' => [ 'ListConfigurationsOutput$Configurations' => 'The list of all revisions for the specified configuration.
', ], ], '__listOfConfigurationId' => [ 'base' => NULL, 'refs' => [ 'Configurations$History' => 'The history of configurations applied to the broker.
', ], ], '__listOfConfigurationRevision' => [ 'base' => NULL, 'refs' => [ 'ListConfigurationRevisionsOutput$Revisions' => 'The list of all revisions for the specified configuration.
', ], ], '__listOfDeploymentMode' => [ 'base' => NULL, 'refs' => [ 'BrokerInstanceOption$SupportedDeploymentModes' => 'The list of supported deployment modes.
', ], ], '__listOfEngineVersion' => [ 'base' => NULL, 'refs' => [ 'BrokerEngineType$EngineVersions' => 'The list of engine versions.
', ], ], '__listOfSanitizationWarning' => [ 'base' => NULL, 'refs' => [ 'UpdateConfigurationOutput$Warnings' => 'The list of the first 20 warnings about the configuration elements or attributes that were sanitized.
', ], ], '__listOfUser' => [ 'base' => NULL, 'refs' => [ 'CreateBrokerInput$Users' => '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.
', ], ], '__listOfUserSummary' => [ 'base' => NULL, 'refs' => [ 'DescribeBrokerOutput$Users' => 'The list of all broker usernames for the specified broker.
', 'ListUsersOutput$Users' => 'Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
', ], ], '__listOf__string' => [ 'base' => NULL, 'refs' => [ 'BrokerInstance$Endpoints' => 'The broker\'s wire-level protocol endpoints.
', 'BrokerInstanceOption$SupportedEngineVersions' => 'The list of supported engine versions.
', 'CreateBrokerInput$SecurityGroups' => 'The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
', 'CreateBrokerInput$SubnetIds' => '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.
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.
', 'DescribeBrokerOutput$PendingSecurityGroups' => 'The list of pending security groups to authorize connections to brokers.
', 'DescribeBrokerOutput$SecurityGroups' => 'The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
', 'DescribeBrokerOutput$SubnetIds' => 'The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
', 'DescribeUserOutput$Groups' => '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.
', 'LdapServerMetadataInput$Hosts' => 'Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
', 'LdapServerMetadataOutput$Hosts' => 'Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
', 'UpdateBrokerInput$SecurityGroups' => 'The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
', 'UpdateBrokerOutput$SecurityGroups' => 'The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
', 'UpdateUserInput$Groups' => '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.
', 'User$Groups' => '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.
', 'UserPendingChanges$Groups' => '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.
', ], ], '__mapOf__string' => [ 'base' => NULL, 'refs' => [ 'Configuration$Tags' => 'The list of all tags associated with this configuration.
', 'CreateBrokerInput$Tags' => 'Create tags when creating the broker.
', 'CreateConfigurationInput$Tags' => 'Create tags when creating the configuration.
', 'DescribeBrokerOutput$Tags' => 'The list of all tags associated with this broker.
', 'Tags$Tags' => 'The key-value pair for the resource tag.
', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'ActionRequired$ActionRequiredCode' => 'The code you can use to find instructions on the action required to resolve your broker issue.
', 'ActionRequired$ActionRequiredInfo' => 'Information about the action required to resolve your broker issue.
', 'AvailabilityZone$Name' => 'Id for the availability zone.
', 'BrokerEngineTypeOutput$NextToken' => 'The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
', 'BrokerInstance$ConsoleURL' => 'The brokers web console URL.
', 'BrokerInstance$IpAddress' => 'The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.
', 'BrokerInstanceOption$HostInstanceType' => 'The broker\'s instance type.
', 'BrokerInstanceOptionsOutput$NextToken' => 'The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
', 'BrokerSummary$BrokerArn' => 'The broker\'s Amazon Resource Name (ARN).
', 'BrokerSummary$BrokerId' => 'The unique ID that Amazon MQ generates for the broker.
', 'BrokerSummary$BrokerName' => '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.
', 'BrokerSummary$HostInstanceType' => 'The broker\'s instance type.
', 'Configuration$Arn' => 'Required. The ARN of the configuration.
', 'Configuration$Description' => 'Required. The description of the configuration.
', 'Configuration$EngineVersion' => 'Required. The broker engine\'s version. For a list of supported engine versions, see, Supported engines.
', 'Configuration$Id' => 'Required. The unique ID that Amazon MQ generates for the configuration.
', 'Configuration$Name' => '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.
', 'ConfigurationId$Id' => 'Required. The unique ID that Amazon MQ generates for the configuration.
', 'ConfigurationRevision$Description' => 'The description of the configuration revision.
', 'CreateBrokerInput$BrokerName' => '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.
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.
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.
', 'CreateBrokerInput$EngineVersion' => 'Required. The broker engine\'s version. For a list of supported engine versions, see Supported engines.
', 'CreateBrokerInput$HostInstanceType' => 'Required. The broker\'s instance type.
', 'CreateBrokerOutput$BrokerArn' => 'The broker\'s Amazon Resource Name (ARN).
', 'CreateBrokerOutput$BrokerId' => 'The unique ID that Amazon MQ generates for the broker.
', 'CreateConfigurationInput$EngineVersion' => 'Required. The broker engine\'s version. For a list of supported engine versions, see Supported engines.
', 'CreateConfigurationInput$Name' => '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.
', 'CreateConfigurationOutput$Arn' => 'Required. The Amazon Resource Name (ARN) of the configuration.
', 'CreateConfigurationOutput$Id' => 'Required. The unique ID that Amazon MQ generates for the configuration.
', 'CreateConfigurationOutput$Name' => '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$Password' => '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 (,:=).
', 'DataReplicationCounterpart$BrokerId' => 'Required. The unique broker id generated by Amazon MQ.
', 'DataReplicationCounterpart$Region' => 'Required. The region of the broker.
', 'DataReplicationMetadataOutput$DataReplicationRole' => 'Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.
', 'DeleteBrokerOutput$BrokerId' => 'The unique ID that Amazon MQ generates for the broker.
', 'DescribeBrokerOutput$BrokerArn' => 'The broker\'s Amazon Resource Name (ARN).
', 'DescribeBrokerOutput$BrokerId' => 'The unique ID that Amazon MQ generates for the broker.
', 'DescribeBrokerOutput$BrokerName' => '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.
', 'DescribeBrokerOutput$EngineVersion' => 'The broker engine\'s version. For a list of supported engine versions, see Supported engines.
', 'DescribeBrokerOutput$HostInstanceType' => 'The broker\'s instance type.
', 'DescribeBrokerOutput$PendingEngineVersion' => 'The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
', 'DescribeBrokerOutput$PendingHostInstanceType' => 'The broker\'s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
', 'DescribeConfigurationRevisionOutput$ConfigurationId' => 'Required. The unique ID that Amazon MQ generates for the configuration.
', 'DescribeConfigurationRevisionOutput$Data' => 'Amazon MQ for ActiveMQ: the base64-encoded XML configuration. Amazon MQ for RabbitMQ: base64-encoded Cuttlefish.
', 'DescribeConfigurationRevisionOutput$Description' => 'The description of the configuration.
', 'DescribeUserOutput$BrokerId' => 'Required. The unique ID that Amazon MQ generates for the broker.
', 'DescribeUserOutput$Username' => '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$KmsKeyId' => '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.
', 'EngineVersion$Name' => 'Id for the version.
', 'Error$ErrorAttribute' => 'The attribute which caused the error.
', 'Error$Message' => 'The explanation of the error.
', 'LdapServerMetadataInput$RoleBase' => '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.
', 'LdapServerMetadataInput$RoleName' => 'Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
', 'LdapServerMetadataInput$RoleSearchMatching' => '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.
', 'LdapServerMetadataInput$ServiceAccountPassword' => '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.
', 'LdapServerMetadataInput$ServiceAccountUsername' => '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.
', 'LdapServerMetadataInput$UserBase' => '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.
', 'LdapServerMetadataInput$UserRoleName' => 'Specifies the name of the LDAP attribute for the user group membership.
', 'LdapServerMetadataInput$UserSearchMatching' => '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.
', 'LdapServerMetadataOutput$RoleBase' => '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.
', 'LdapServerMetadataOutput$RoleName' => 'Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
', 'LdapServerMetadataOutput$RoleSearchMatching' => '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.
', 'LdapServerMetadataOutput$ServiceAccountUsername' => '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.
', 'LdapServerMetadataOutput$UserBase' => '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.
', 'LdapServerMetadataOutput$UserRoleName' => 'Specifies the name of the LDAP attribute for the user group membership.
', 'LdapServerMetadataOutput$UserSearchMatching' => '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.
', 'ListBrokersOutput$NextToken' => 'The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
', 'ListConfigurationRevisionsOutput$ConfigurationId' => 'The unique ID that Amazon MQ generates for the configuration.
', 'ListConfigurationRevisionsOutput$NextToken' => 'The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
', 'ListConfigurationsOutput$NextToken' => 'The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
', 'ListUsersOutput$BrokerId' => 'Required. The unique ID that Amazon MQ generates for the broker.
', 'ListUsersOutput$NextToken' => 'The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
', 'LogsSummary$AuditLogGroup' => 'The location of the CloudWatch Logs log group where audit logs are sent.
', 'LogsSummary$GeneralLogGroup' => 'The location of the CloudWatch Logs log group where general logs are sent.
', 'PromoteOutput$BrokerId' => 'The unique ID that Amazon MQ generates for the broker.
', 'SanitizationWarning$AttributeName' => 'The name of the configuration attribute that has been sanitized.
', 'SanitizationWarning$ElementName' => 'The name of the configuration element that has been sanitized.
', 'UpdateBrokerInput$EngineVersion' => 'The broker engine version. For a list of supported engine versions, see Supported engines.
', 'UpdateBrokerInput$HostInstanceType' => 'The broker\'s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
', 'UpdateBrokerOutput$BrokerId' => 'Required. The unique ID that Amazon MQ generates for the broker.
', 'UpdateBrokerOutput$EngineVersion' => 'The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
', 'UpdateBrokerOutput$HostInstanceType' => 'The broker\'s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
', 'UpdateConfigurationInput$Data' => 'Amazon MQ for Active MQ: The base64-encoded XML configuration. Amazon MQ for RabbitMQ: the base64-encoded Cuttlefish configuration.
', 'UpdateConfigurationInput$Description' => 'The description of the configuration.
', 'UpdateConfigurationOutput$Arn' => 'The Amazon Resource Name (ARN) of the configuration.
', 'UpdateConfigurationOutput$Id' => 'The unique ID that Amazon MQ generates for the configuration.
', 'UpdateConfigurationOutput$Name' => '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.
', 'UpdateUserInput$Password' => '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 (,:=).
', 'User$Password' => '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 (,:=).
', 'User$Username' => '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.
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$TimeOfDay' => 'Required. The time, in 24-hour format.
', 'WeeklyStartTime$TimeZone' => 'The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
', '__listOf__string$member' => NULL, '__mapOf__string$member' => NULL, ], ], '__timestampIso8601' => [ 'base' => NULL, 'refs' => [ 'BrokerSummary$Created' => 'The time when the broker was created.
', 'Configuration$Created' => 'Required. The date and time of the configuration revision.
', 'ConfigurationRevision$Created' => 'Required. The date and time of the configuration revision.
', 'CreateConfigurationOutput$Created' => 'Required. The date and time of the configuration.
', 'DescribeBrokerOutput$Created' => 'The time when the broker was created.
', 'DescribeConfigurationRevisionOutput$Created' => 'Required. The date and time of the configuration.
', 'UpdateConfigurationOutput$Created' => 'Required. The date and time of the configuration.
', ], ], ],];