mq_update_broker: Adds a pending configuration change to a broker

Description Usage Arguments Value Request syntax

View source: R/mq_operations.R

Description

Adds a pending configuration change to a broker.

Usage

1
2
3
mq_update_broker(AuthenticationStrategy, AutoMinorVersionUpgrade,
  BrokerId, Configuration, EngineVersion, HostInstanceType,
  LdapServerMetadata, Logs, SecurityGroups)

Arguments

AuthenticationStrategy

The authentication strategy used to secure the broker.

AutoMinorVersionUpgrade

Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.

BrokerId

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

Configuration

A list of information about the configuration.

EngineVersion

The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html

HostInstanceType

The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html\#broker-instance-types

LdapServerMetadata

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

Logs

Enables Amazon CloudWatch logging for brokers.

SecurityGroups

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
  ),
  SecurityGroups = list(
    "string"
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
  ),
  SecurityGroups = list(
    "string"
  )
)

paws.application.integration documentation built on Aug. 23, 2021, 9:20 a.m.