Module Values.DescribeBrokerResponseSource

Returns information about the specified broker.

Sourcetype nonrec t = {
  1. actionsRequired : ActionRequired.t list option;
    (*

    Actions required for a broker.

    *)
  2. authenticationStrategy : AuthenticationStrategy.t option;
    (*

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

    *)
  3. autoMinorVersionUpgrade : bool option;
    (*

    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.

    *)
  4. brokerArn : string option;
    (*

    The broker's Amazon Resource Name (ARN).

    *)
  5. brokerId : string option;
    (*

    The unique ID that Amazon MQ generates for the broker.

    *)
  6. brokerInstances : BrokerInstance.t list option;
    (*

    A list of information about allocated brokers.

    *)
  7. brokerName : string option;
    (*

    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.

    *)
  8. brokerState : BrokerState.t option;
    (*

    The broker's status.

    *)
  9. configurations : Configurations.t option;
    (*

    The list of all revisions for the specified configuration.

    *)
  10. created : string option;
    (*

    The time when the broker was created.

    *)
  11. deploymentMode : DeploymentMode.t option;
    (*

    The broker's deployment mode.

    *)
  12. encryptionOptions : EncryptionOptions.t option;
    (*

    Encryption options for the broker.

    *)
  13. engineType : EngineType.t option;
    (*

    The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

    *)
  14. engineVersion : string option;
    (*

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

    *)
  15. hostInstanceType : string option;
    (*

    The broker's instance type.

    *)
  16. ldapServerMetadata : LdapServerMetadataOutput.t option;
    (*

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

    *)
  17. logs : LogsSummary.t option;
    (*

    The list of information about logs currently enabled and pending to be deployed for the specified broker.

    *)
  18. maintenanceWindowStartTime : WeeklyStartTime.t option;
    (*

    The parameters that determine the WeeklyStartTime.

    *)
  19. pendingAuthenticationStrategy : AuthenticationStrategy.t option;
    (*

    The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

    *)
  20. pendingEngineVersion : string option;
    (*

    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.

    *)
  21. pendingHostInstanceType : string option;
    (*

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

    *)
  22. pendingLdapServerMetadata : LdapServerMetadataOutput.t option;
    (*

    The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

    *)
  23. pendingSecurityGroups : string list option;
    (*

    The list of pending security groups to authorize connections to brokers.

    *)
  24. publiclyAccessible : bool option;
    (*

    Enables connections from applications outside of the VPC that hosts the broker's subnets.

    *)
  25. securityGroups : string list option;
    (*

    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

    *)
  26. storageType : BrokerStorageType.t option;
    (*

    The broker's storage type.

    *)
  27. subnetIds : string list option;
    (*

    The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

    *)
  28. tags : (string * string) list option;
    (*

    The list of all tags associated with this broker.

    *)
  29. users : UserSummary.t list option;
    (*

    The list of all broker usernames for the specified broker.

    *)
  30. dataReplicationMetadata : DataReplicationMetadataOutput.t option;
    (*

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

    *)
  31. dataReplicationMode : DataReplicationMode.t option;
    (*

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

    *)
  32. pendingDataReplicationMetadata : DataReplicationMetadataOutput.t option;
    (*

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

    *)
  33. pendingDataReplicationMode : DataReplicationMode.t option;
    (*

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

    *)
}
Sourcetype nonrec error = [
  1. | `BadRequestException of BadRequestException.t
  2. | `ForbiddenException of ForbiddenException.t
  3. | `InternalServerErrorException of InternalServerErrorException.t
  4. | `NotFoundException of NotFoundException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?actionsRequired:??? -> ?authenticationStrategy:??? -> ?autoMinorVersionUpgrade:??? -> ?brokerArn:??? -> ?brokerId:??? -> ?brokerInstances:??? -> ?brokerName:??? -> ?brokerState:??? -> ?configurations:??? -> ?created:??? -> ?deploymentMode:??? -> ?encryptionOptions:??? -> ?engineType:??? -> ?engineVersion:??? -> ?hostInstanceType:??? -> ?ldapServerMetadata:??? -> ?logs:??? -> ?maintenanceWindowStartTime:??? -> ?pendingAuthenticationStrategy:??? -> ?pendingEngineVersion:??? -> ?pendingHostInstanceType:??? -> ?pendingLdapServerMetadata:??? -> ?pendingSecurityGroups:??? -> ?publiclyAccessible:??? -> ?securityGroups:??? -> ?storageType:??? -> ?subnetIds:??? -> ?tags:??? -> ?users:??? -> ?dataReplicationMetadata:??? -> ?dataReplicationMode:??? -> ?pendingDataReplicationMetadata:??? -> ?pendingDataReplicationMode:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `BadRequestException of BadRequestException.t | `ForbiddenException of ForbiddenException.t | `InternalServerErrorException of InternalServerErrorException.t | `NotFoundException of NotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `BadRequestException of BadRequestException.t | `ForbiddenException of ForbiddenException.t | `InternalServerErrorException of InternalServerErrorException.t | `NotFoundException of NotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of bool | `Enum of string | `List of [> `String of string | `Structure of (string * [> `Enum of string | `List of [> `String of string ] list | `String of string ]) list ] list | `Map of ([> `String of string ] * [> `String of string ]) list | `String of string | `Structure of (string * [> `Boolean of bool | `Enum of string | `List of [> `String of string | `Structure of (string * [> `Integer of int | `String of string ]) list ] list | `String of string | `Structure of (string * [> `Boolean of bool | `Integer of int | `String of string ]) list ]) list | `Timestamp of string ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t