[ aws . mq ]

update-broker

Description

Adds a pending configuration change to a broker.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-broker
[--authentication-strategy <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
--broker-id <value>
[--configuration <value>]
[--engine-version <value>]
[--host-instance-type <value>]
[--ldap-server-metadata <value>]
[--logs <value>]
[--security-groups <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--authentication-strategy (string) The authentication strategy used to secure the broker.

Possible values:

• SIMPLE

• LDAP

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (boolean) 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.

--broker-id (string) The unique ID that Amazon MQ generates for the broker.

--configuration (structure) A list of information about the configuration.Id -> (string)

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

Revision -> (integer)

The revision number of the configuration.

Shorthand Syntax:

Id=string,Revision=integer

JSON Syntax:

{
  "Id": "string",
  "Revision": integer
}

--engine-version (string) 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

--host-instance-type (string) 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

--ldap-server-metadata (structure) The metadata of the LDAP server used to authenticate and authorize connections to the broker.Hosts -> (list)

Fully qualified domain name of the LDAP server. Optional failover server.

(string)

RoleBase -> (string)

Fully qualified name of the directory to search for a user’s groups.

RoleName -> (string)

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

RoleSearchMatching -> (string)

The search criteria for groups.

RoleSearchSubtree -> (boolean)

The directory search scope for the role. If set to true, scope is to search the entire sub-tree.

ServiceAccountPassword -> (string)

Service account password.

ServiceAccountUsername -> (string)

Service account username.

UserBase -> (string)

Fully qualified name of the directory where you want to search for users.

UserRoleName -> (string)

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

UserSearchMatching -> (string)

The search criteria for users.

UserSearchSubtree -> (boolean)

The directory search scope for the user. If set to true, scope is to search the entire sub-tree.

Shorthand Syntax:

Hosts=string,string,RoleBase=string,RoleName=string,RoleSearchMatching=string,RoleSearchSubtree=boolean,ServiceAccountPassword=string,ServiceAccountUsername=string,UserBase=string,UserRoleName=string,UserSearchMatching=string,UserSearchSubtree=boolean

JSON Syntax:

{
  "Hosts": ["string", ...],
  "RoleBase": "string",
  "RoleName": "string",
  "RoleSearchMatching": "string",
  "RoleSearchSubtree": true|false,
  "ServiceAccountPassword": "string",
  "ServiceAccountUsername": "string",
  "UserBase": "string",
  "UserRoleName": "string",
  "UserSearchMatching": "string",
  "UserSearchSubtree": true|false
}

--logs (structure) Enables Amazon CloudWatch logging for brokers.Audit -> (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 -> (boolean)

Enables general logging.

Shorthand Syntax:

Audit=boolean,General=boolean

JSON Syntax:

{
  "Audit": true|false,
  "General": true|false
}

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

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AuthenticationStrategy -> (string)

The authentication strategy used to secure the broker.

AutoMinorVersionUpgrade -> (boolean)

The new value of automatic upgrades to new minor version for brokers.

BrokerId -> (string)

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

Configuration -> (structure)

The ID of the updated configuration.

Id -> (string)

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

Revision -> (integer)

The revision number of the configuration.

EngineVersion -> (string)

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

HostInstanceType -> (string)

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 -> (structure)

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

Hosts -> (list)

Fully qualified domain name of the LDAP server. Optional failover server.

(string)

RoleBase -> (string)

Fully qualified name of the directory to search for a user’s groups.

RoleName -> (string)

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

RoleSearchMatching -> (string)

The search criteria for groups.

RoleSearchSubtree -> (boolean)

The directory search scope for the role. If set to true, scope is to search the entire sub-tree.

ServiceAccountUsername -> (string)

Service account username.

UserBase -> (string)

Fully qualified name of the directory where you want to search for users.

UserRoleName -> (string)

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

UserSearchMatching -> (string)

The search criteria for users.

UserSearchSubtree -> (boolean)

The directory search scope for the user. If set to true, scope is to search the entire sub-tree.

Logs -> (structure)

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

Audit -> (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 -> (boolean)

Enables general logging.

SecurityGroups -> (list)

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

(string)