Mq class
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.
Constructors
- Mq({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createBroker(
{required String brokerName, required DeploymentMode deploymentMode, required EngineType engineType, required String hostInstanceType, required bool publiclyAccessible, AuthenticationStrategy? authenticationStrategy, bool? autoMinorVersionUpgrade, ConfigurationId? configuration, String? creatorRequestId, DataReplicationMode? dataReplicationMode, String? dataReplicationPrimaryBrokerArn, EncryptionOptions? encryptionOptions, String? engineVersion, LdapServerMetadataInput? ldapServerMetadata, Logs? logs, WeeklyStartTime? maintenanceWindowStartTime, List< String> ? securityGroups, BrokerStorageType? storageType, List<String> ? subnetIds, Map<String, String> ? tags, List<User> ? users}) → Future<CreateBrokerResponse> - Creates a broker. Note: This API is asynchronous.
-
createConfiguration(
{required EngineType engineType, required String name, AuthenticationStrategy? authenticationStrategy, String? engineVersion, Map< String, String> ? tags}) → Future<CreateConfigurationResponse> - Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
-
createTags(
{required String resourceArn, Map< String, String> ? tags}) → Future<void> - Add a tag to a resource.
-
createUser(
{required String brokerId, required String password, required String username, bool? consoleAccess, List< String> ? groups, bool? replicationUser}) → Future<void> - Creates an ActiveMQ user.
-
deleteBroker(
{required String brokerId}) → Future< DeleteBrokerResponse> - Deletes a broker. Note: This API is asynchronous.
-
deleteConfiguration(
{required String configurationId}) → Future< DeleteConfigurationResponse> - Deletes the specified configuration.
-
deleteTags(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes a tag from a resource.
-
deleteUser(
{required String brokerId, required String username}) → Future< void> - Deletes an ActiveMQ user.
-
describeBroker(
{required String brokerId}) → Future< DescribeBrokerResponse> - Returns information about the specified broker.
-
describeBrokerEngineTypes(
{String? engineType, int? maxResults, String? nextToken}) → Future< DescribeBrokerEngineTypesResponse> - Describe available engine types and versions.
-
describeBrokerInstanceOptions(
{String? engineType, String? hostInstanceType, int? maxResults, String? nextToken, String? storageType}) → Future< DescribeBrokerInstanceOptionsResponse> - Describe available broker instance options.
-
describeConfiguration(
{required String configurationId}) → Future< DescribeConfigurationResponse> - Returns information about the specified configuration.
-
describeConfigurationRevision(
{required String configurationId, required String configurationRevision}) → Future< DescribeConfigurationRevisionResponse> - Returns the specified configuration revision for the specified configuration.
-
describeUser(
{required String brokerId, required String username}) → Future< DescribeUserResponse> - Returns information about an ActiveMQ user.
-
listBrokers(
{int? maxResults, String? nextToken}) → Future< ListBrokersResponse> - Returns a list of all brokers.
-
listConfigurationRevisions(
{required String configurationId, int? maxResults, String? nextToken}) → Future< ListConfigurationRevisionsResponse> - Returns a list of all revisions for the specified configuration.
-
listConfigurations(
{int? maxResults, String? nextToken}) → Future< ListConfigurationsResponse> - Returns a list of all configurations.
-
listTags(
{required String resourceArn}) → Future< ListTagsResponse> - Lists tags for a resource.
-
listUsers(
{required String brokerId, int? maxResults, String? nextToken}) → Future< ListUsersResponse> - Returns a list of all ActiveMQ users.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
promote(
{required String brokerId, required PromoteMode mode}) → Future< PromoteResponse> - Promotes a data replication replica broker to the primary broker role.
-
rebootBroker(
{required String brokerId}) → Future< void> - Reboots a broker. Note: This API is asynchronous.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateBroker(
{required String brokerId, AuthenticationStrategy? authenticationStrategy, bool? autoMinorVersionUpgrade, ConfigurationId? configuration, DataReplicationMode? dataReplicationMode, String? engineVersion, String? hostInstanceType, LdapServerMetadataInput? ldapServerMetadata, Logs? logs, WeeklyStartTime? maintenanceWindowStartTime, List< String> ? securityGroups}) → Future<UpdateBrokerResponse> - Adds a pending configuration change to a broker.
-
updateConfiguration(
{required String configurationId, required String data, String? description}) → Future< UpdateConfigurationResponse> - Updates the specified configuration.
-
updateUser(
{required String brokerId, required String username, bool? consoleAccess, List< String> ? groups, String? password, bool? replicationUser}) → Future<void> - Updates the information for an ActiveMQ user.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited