Skip to content

UpdateBrokerRequest

Source code in docs_src/capo_mq/types/update_broker_request.py
class UpdateBrokerRequest(TypedDict, closed=True):
    authentication_strategy: NotRequired[
        "capo_mq.types.authentication_strategy.AuthenticationStrategy"
    ]
    """<p>Optional. The authentication strategy used to secure the broker. The default is SIMPLE.</p>"""
    auto_minor_version_upgrade: NotRequired["capo_mq.types.__boolean.__boolean"]
    """<p>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.</p> <note><p>Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.</p></note>"""
    broker_id: "capo_mq.types.__string.__string"
    """<p>The unique ID that Amazon MQ generates for the broker.</p>"""
    configuration: NotRequired["capo_mq.types.configuration_id.ConfigurationId"]
    """<p>A list of information about the configuration.</p>"""
    engine_version: NotRequired["capo_mq.types.__string.__string"]
    """<p>The broker engine version. For more information, see the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/activemq-version-management.html">ActiveMQ version management</a> and the <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/rabbitmq-version-management.html">RabbitMQ version management</a> sections in the Amazon MQ Developer Guide.</p> <note><p>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.</p></note>"""
    host_instance_type: NotRequired["capo_mq.types.__string.__string"]
    """<p>The broker's host instance type to upgrade to. For a list of supported instance types, see <a href="https://docs.aws.amazon.com//amazon-mq/latest/developer-guide/broker.html#broker-instance-types">Broker instance types</a>.</p>"""
    ldap_server_metadata: NotRequired[
        "capo_mq.types.ldap_server_metadata_input.LdapServerMetadataInput"
    ]
    """<p>Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.</p>"""
    logs: NotRequired["capo_mq.types.logs.Logs"]
    """<p>Enables Amazon CloudWatch logging for brokers.</p>"""
    maintenance_window_start_time: NotRequired[
        "capo_mq.types.weekly_start_time.WeeklyStartTime"
    ]
    """<p>The parameters that determine the WeeklyStartTime.</p>"""
    resource_share_arns: NotRequired["capo_mq.types.__list_of__string.__listOf__string"]
    """<p>The list of resource shares to update on the broker</p>"""
    security_groups: NotRequired["capo_mq.types.__list_of__string.__listOf__string"]
    """<p>The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.</p>"""
    storage_size: NotRequired["capo_mq.types.__integer.__integer"]
    """<p>The broker's storage size in GB.</p>"""
    data_replication_mode: NotRequired[
        "capo_mq.types.data_replication_mode.DataReplicationMode"
    ]
    """<p>Defines whether this broker is a part of a data replication pair.</p>"""

authentication_strategy instance-attribute

authentication_strategy: NotRequired[AuthenticationStrategy]

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

auto_minor_version_upgrade instance-attribute

auto_minor_version_upgrade: NotRequired[__boolean]

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.

broker_id instance-attribute

broker_id: __string

The unique ID that Amazon MQ generates for the broker.

configuration instance-attribute

configuration: NotRequired[ConfigurationId]

A list of information about the configuration.

data_replication_mode instance-attribute

data_replication_mode: NotRequired[DataReplicationMode]

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

engine_version instance-attribute

engine_version: NotRequired[__string]

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.

host_instance_type instance-attribute

host_instance_type: NotRequired[__string]

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

ldap_server_metadata instance-attribute

ldap_server_metadata: NotRequired[LdapServerMetadataInput]

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

logs instance-attribute

logs: NotRequired[Logs]

Enables Amazon CloudWatch logging for brokers.

maintenance_window_start_time instance-attribute

maintenance_window_start_time: NotRequired[WeeklyStartTime]

The parameters that determine the WeeklyStartTime.

resource_share_arns instance-attribute

resource_share_arns: NotRequired[__listOf__string]

The list of resource shares to update on the broker

security_groups instance-attribute

security_groups: NotRequired[__listOf__string]

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

storage_size instance-attribute

storage_size: NotRequired[__integer]

The broker's storage size in GB.