Skip to content

Update Broker

mq_update_broker R Documentation

Adds a pending configuration change to a broker

Description

Adds a pending configuration change to a broker.

Usage

mq_update_broker(AuthenticationStrategy, AutoMinorVersionUpgrade,
  BrokerId, Configuration, EngineVersion, HostInstanceType,
  LdapServerMetadata, Logs, MaintenanceWindowStartTime, SecurityGroups,
  DataReplicationMode)

Arguments

AuthenticationStrategy

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

AutoMinorVersionUpgrade

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.

BrokerId

[required] The unique ID that Amazon MQ generates for the broker.

Configuration

A list of information about the configuration.

EngineVersion

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

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

LdapServerMetadata

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

Logs

Enables Amazon CloudWatch logging for brokers.

MaintenanceWindowStartTime

The parameters that determine the WeeklyStartTime.

SecurityGroups

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

DataReplicationMode

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

Value

A list with the following syntax: 

list(
  AuthenticationStrategy = "SIMPLE"|"LDAP",
  AutoMinorVersionUpgrade = TRUE|FALSE,
  BrokerId = "string",
  Configuration = list(
    Id = "string",
    Revision = 123
  ),
  EngineVersion = "string",
  HostInstanceType = "string",
  LdapServerMetadata = list(
    Hosts = list(
      "string"
    ),
    RoleBase = "string",
    RoleName = "string",
    RoleSearchMatching = "string",
    RoleSearchSubtree = TRUE|FALSE,
    ServiceAccountUsername = "string",
    UserBase = "string",
    UserRoleName = "string",
    UserSearchMatching = "string",
    UserSearchSubtree = TRUE|FALSE
  ),
  Logs = list(
    Audit = TRUE|FALSE,
    General = TRUE|FALSE
  ),
  MaintenanceWindowStartTime = list(
    DayOfWeek = "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY",
    TimeOfDay = "string",
    TimeZone = "string"
  ),
  SecurityGroups = list(
    "string"
  ),
  DataReplicationMetadata = list(
    DataReplicationCounterpart = list(
      BrokerId = "string",
      Region = "string"
    ),
    DataReplicationRole = "string"
  ),
  DataReplicationMode = "NONE"|"CRDR",
  PendingDataReplicationMetadata = list(
    DataReplicationCounterpart = list(
      BrokerId = "string",
      Region = "string"
    ),
    DataReplicationRole = "string"
  ),
  PendingDataReplicationMode = "NONE"|"CRDR"
)

Request syntax

svc$update_broker(
  AuthenticationStrategy = "SIMPLE"|"LDAP",
  AutoMinorVersionUpgrade = TRUE|FALSE,
  BrokerId = "string",
  Configuration = list(
    Id = "string",
    Revision = 123
  ),
  EngineVersion = "string",
  HostInstanceType = "string",
  LdapServerMetadata = list(
    Hosts = list(
      "string"
    ),
    RoleBase = "string",
    RoleName = "string",
    RoleSearchMatching = "string",
    RoleSearchSubtree = TRUE|FALSE,
    ServiceAccountPassword = "string",
    ServiceAccountUsername = "string",
    UserBase = "string",
    UserRoleName = "string",
    UserSearchMatching = "string",
    UserSearchSubtree = TRUE|FALSE
  ),
  Logs = list(
    Audit = TRUE|FALSE,
    General = TRUE|FALSE
  ),
  MaintenanceWindowStartTime = list(
    DayOfWeek = "MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY",
    TimeOfDay = "string",
    TimeZone = "string"
  ),
  SecurityGroups = list(
    "string"
  ),
  DataReplicationMode = "NONE"|"CRDR"
)