DescribeBrokerResponse ¶

class DescribeBrokerResponse(TypedDict, closed=True):
    actions_required: NotRequired[
        "capo_mq.types.__list_of_action_required.__listOfActionRequired"
    ]
    """<p>Actions required for a broker.</p>"""
    authentication_strategy: NotRequired[
        "capo_mq.types.authentication_strategy.AuthenticationStrategy"
    ]
    """<p>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_arn: NotRequired["capo_mq.types.__string.__string"]
    """<p>The broker's Amazon Resource Name (ARN).</p>"""
    broker_id: NotRequired["capo_mq.types.__string.__string"]
    """<p>The unique ID that Amazon MQ generates for the broker.</p>"""
    broker_instances: NotRequired[
        "capo_mq.types.__list_of_broker_instance.__listOfBrokerInstance"
    ]
    """<p>A list of information about allocated brokers.</p>"""
    broker_name: NotRequired["capo_mq.types.__string.__string"]
    """<p>The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.</p>"""
    broker_state: NotRequired["capo_mq.types.broker_state.BrokerState"]
    """<p>The broker's status.</p>"""
    configurations: NotRequired["capo_mq.types.configurations.Configurations"]
    """<p>The list of all revisions for the specified configuration.</p>"""
    created: NotRequired["capo_mq.types.__timestamp_iso8601.__timestampIso8601"]
    """<p>The time when the broker was created.</p>"""
    deployment_mode: NotRequired["capo_mq.types.deployment_mode.DeploymentMode"]
    """<p>The broker's deployment mode.</p>"""
    encryption_options: NotRequired[
        "capo_mq.types.encryption_options.EncryptionOptions"
    ]
    """<p>Encryption options for the broker.</p>"""
    engine_type: NotRequired["capo_mq.types.engine_type.EngineType"]
    """<p>The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.</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>"""
    host_instance_type: NotRequired["capo_mq.types.__string.__string"]
    """<p>The broker's instance type.</p>"""
    ldap_server_metadata: NotRequired[
        "capo_mq.types.ldap_server_metadata_output.LdapServerMetadataOutput"
    ]
    """<p>The metadata of the LDAP server used to authenticate and authorize connections to the broker.</p>"""
    logs: NotRequired["capo_mq.types.logs_summary.LogsSummary"]
    """<p>The list of information about logs currently enabled and pending to be deployed 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>"""
    pending_authentication_strategy: NotRequired[
        "capo_mq.types.authentication_strategy.AuthenticationStrategy"
    ]
    """<p>The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.</p>"""
    pending_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>"""
    pending_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>"""
    pending_ldap_server_metadata: NotRequired[
        "capo_mq.types.ldap_server_metadata_output.LdapServerMetadataOutput"
    ]
    """<p>The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.</p>"""
    pending_security_groups: NotRequired[
        "capo_mq.types.__list_of__string.__listOf__string"
    ]
    """<p>The list of pending security groups to authorize connections to brokers.</p>"""
    pending_storage_size: NotRequired["capo_mq.types.__integer.__integer"]
    """<p>The pending storage size in GB, to be applied on the next broker restart.</p>"""
    publicly_accessible: NotRequired["capo_mq.types.__boolean.__boolean"]
    """<p>Enables connections from applications outside of the VPC that hosts the broker's subnets.</p>"""
    security_groups: NotRequired["capo_mq.types.__list_of__string.__listOf__string"]
    """<p>The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.</p>"""
    storage_size: NotRequired["capo_mq.types.__integer.__integer"]
    """<p>The broker's storage size in GB.</p>"""
    storage_type: NotRequired["capo_mq.types.broker_storage_type.BrokerStorageType"]
    """<p>The broker's storage type.</p>"""
    subnet_ids: NotRequired["capo_mq.types.__list_of__string.__listOf__string"]
    """<p>The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.</p>"""
    tags: NotRequired["capo_mq.types.__map_of__string.__mapOf__string"]
    """<p>The list of all tags associated with this broker.</p>"""
    users: NotRequired["capo_mq.types.__list_of_user_summary.__listOfUserSummary"]
    """<p>The list of all broker usernames for the specified broker.</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>"""