Skip to content

UpdateBrokerResponse

Source code in docs_src/capo_mq/types/update_broker_response.py
class UpdateBrokerResponse(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>"""
    broker_id: NotRequired["capo_mq.types.__string.__string"]
    """<p>Required. The unique ID that Amazon MQ generates for the broker.</p>"""
    configuration: NotRequired["capo_mq.types.configuration_id.ConfigurationId"]
    """<p>The ID of the updated configuration.</p>"""
    engine_version: NotRequired["capo_mq.types.__string.__string"]
    """<p>The broker engine version to upgrade to. 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>"""
    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_output.LdapServerMetadataOutput"
    ]
    """<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>The list of information about logs to be enabled for the specified broker.</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 pending broker's target list of resource shares</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>"""
    data_replication_metadata: NotRequired[
        "capo_mq.types.data_replication_metadata_output.DataReplicationMetadataOutput"
    ]
    """<p>The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.</p>"""
    data_replication_mode: NotRequired[
        "capo_mq.types.data_replication_mode.DataReplicationMode"
    ]
    """<p>Describes whether this broker is a part of a data replication pair.</p>"""
    pending_data_replication_metadata: NotRequired[
        "capo_mq.types.data_replication_metadata_output.DataReplicationMetadataOutput"
    ]
    """<p>The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.</p>"""
    pending_data_replication_mode: NotRequired[
        "capo_mq.types.data_replication_mode.DataReplicationMode"
    ]
    """<p>Describes whether this broker will be a part of a data replication pair after reboot.</p>"""
    storage_size: NotRequired["capo_mq.types.__integer.__integer"]
    """<p>The broker's storage size in GB.</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.

broker_id instance-attribute

broker_id: NotRequired[__string]

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

configuration instance-attribute

configuration: NotRequired[ConfigurationId]

The ID of the updated configuration.

data_replication_metadata instance-attribute

data_replication_metadata: NotRequired[DataReplicationMetadataOutput]

The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

data_replication_mode instance-attribute

data_replication_mode: NotRequired[DataReplicationMode]

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

engine_version instance-attribute

engine_version: NotRequired[__string]

The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.

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[LdapServerMetadataOutput]

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]

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

maintenance_window_start_time instance-attribute

maintenance_window_start_time: NotRequired[WeeklyStartTime]

The parameters that determine the WeeklyStartTime.

pending_data_replication_metadata instance-attribute

pending_data_replication_metadata: NotRequired[DataReplicationMetadataOutput]

The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

pending_data_replication_mode instance-attribute

pending_data_replication_mode: NotRequired[DataReplicationMode]

Describes whether this broker will be a part of a data replication pair after reboot.

resource_share_arns instance-attribute

resource_share_arns: NotRequired[__listOf__string]

The pending broker's target list of resource shares

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.