Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Returns information about the specified broker.
Synopsis
- data DescribeBroker = DescribeBroker' {}
- newDescribeBroker :: Text -> DescribeBroker
- describeBroker_brokerId :: Lens' DescribeBroker Text
- data DescribeBrokerResponse = DescribeBrokerResponse' {
- brokerName :: Maybe Text
- engineVersion :: Maybe Text
- pendingAuthenticationStrategy :: Maybe AuthenticationStrategy
- brokerState :: Maybe BrokerState
- publiclyAccessible :: Maybe Bool
- autoMinorVersionUpgrade :: Maybe Bool
- securityGroups :: Maybe [Text]
- users :: Maybe [UserSummary]
- pendingSecurityGroups :: Maybe [Text]
- subnetIds :: Maybe [Text]
- created :: Maybe POSIX
- configurations :: Maybe Configurations
- authenticationStrategy :: Maybe AuthenticationStrategy
- pendingHostInstanceType :: Maybe Text
- ldapServerMetadata :: Maybe LdapServerMetadataOutput
- maintenanceWindowStartTime :: Maybe WeeklyStartTime
- logs :: Maybe LogsSummary
- encryptionOptions :: Maybe EncryptionOptions
- deploymentMode :: Maybe DeploymentMode
- pendingEngineVersion :: Maybe Text
- brokerId :: Maybe Text
- pendingLdapServerMetadata :: Maybe LdapServerMetadataOutput
- engineType :: Maybe EngineType
- brokerArn :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- brokerInstances :: Maybe [BrokerInstance]
- hostInstanceType :: Maybe Text
- storageType :: Maybe BrokerStorageType
- httpStatus :: Int
- newDescribeBrokerResponse :: Int -> DescribeBrokerResponse
- describeBrokerResponse_brokerName :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_engineVersion :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_pendingAuthenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy)
- describeBrokerResponse_brokerState :: Lens' DescribeBrokerResponse (Maybe BrokerState)
- describeBrokerResponse_publiclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool)
- describeBrokerResponse_autoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool)
- describeBrokerResponse_securityGroups :: Lens' DescribeBrokerResponse (Maybe [Text])
- describeBrokerResponse_users :: Lens' DescribeBrokerResponse (Maybe [UserSummary])
- describeBrokerResponse_pendingSecurityGroups :: Lens' DescribeBrokerResponse (Maybe [Text])
- describeBrokerResponse_subnetIds :: Lens' DescribeBrokerResponse (Maybe [Text])
- describeBrokerResponse_created :: Lens' DescribeBrokerResponse (Maybe UTCTime)
- describeBrokerResponse_configurations :: Lens' DescribeBrokerResponse (Maybe Configurations)
- describeBrokerResponse_authenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy)
- describeBrokerResponse_pendingHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_ldapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput)
- describeBrokerResponse_maintenanceWindowStartTime :: Lens' DescribeBrokerResponse (Maybe WeeklyStartTime)
- describeBrokerResponse_logs :: Lens' DescribeBrokerResponse (Maybe LogsSummary)
- describeBrokerResponse_encryptionOptions :: Lens' DescribeBrokerResponse (Maybe EncryptionOptions)
- describeBrokerResponse_deploymentMode :: Lens' DescribeBrokerResponse (Maybe DeploymentMode)
- describeBrokerResponse_pendingEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_brokerId :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_pendingLdapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput)
- describeBrokerResponse_engineType :: Lens' DescribeBrokerResponse (Maybe EngineType)
- describeBrokerResponse_brokerArn :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_tags :: Lens' DescribeBrokerResponse (Maybe (HashMap Text Text))
- describeBrokerResponse_brokerInstances :: Lens' DescribeBrokerResponse (Maybe [BrokerInstance])
- describeBrokerResponse_hostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text)
- describeBrokerResponse_storageType :: Lens' DescribeBrokerResponse (Maybe BrokerStorageType)
- describeBrokerResponse_httpStatus :: Lens' DescribeBrokerResponse Int
Creating a Request
data DescribeBroker Source #
See: newDescribeBroker
smart constructor.
Instances
Create a value of DescribeBroker
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:brokerId:DescribeBroker'
, describeBroker_brokerId
- The unique ID that Amazon MQ generates for the broker.
Request Lenses
describeBroker_brokerId :: Lens' DescribeBroker Text Source #
The unique ID that Amazon MQ generates for the broker.
Destructuring the Response
data DescribeBrokerResponse Source #
See: newDescribeBrokerResponse
smart constructor.
DescribeBrokerResponse' | |
|
Instances
newDescribeBrokerResponse Source #
Create a value of DescribeBrokerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:brokerName:DescribeBrokerResponse'
, describeBrokerResponse_brokerName
- The broker's name. This value must be unique in your AWS 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.
$sel:engineVersion:DescribeBrokerResponse'
, describeBrokerResponse_engineVersion
- The broker engine's version. For a list of supported engine versions,
see
Supported engines.
$sel:pendingAuthenticationStrategy:DescribeBrokerResponse'
, describeBrokerResponse_pendingAuthenticationStrategy
- The authentication strategy that will be applied when the broker is
rebooted. The default is SIMPLE.
$sel:brokerState:DescribeBrokerResponse'
, describeBrokerResponse_brokerState
- The broker's status.
$sel:publiclyAccessible:DescribeBrokerResponse'
, describeBrokerResponse_publiclyAccessible
- Enables connections from applications outside of the VPC that hosts the
broker's subnets.
$sel:autoMinorVersionUpgrade:DescribeBrokerResponse'
, describeBrokerResponse_autoMinorVersionUpgrade
- Enables automatic upgrades to new minor versions for brokers, as new
versions are released and supported by Amazon MQ. Automatic upgrades
occur during the scheduled maintenance window of the broker or after a
manual broker reboot.
$sel:securityGroups:DescribeBrokerResponse'
, describeBrokerResponse_securityGroups
- The list of rules (1 minimum, 125 maximum) that authorize connections to
brokers.
$sel:users:DescribeBrokerResponse'
, describeBrokerResponse_users
- The list of all broker usernames for the specified broker.
$sel:pendingSecurityGroups:DescribeBrokerResponse'
, describeBrokerResponse_pendingSecurityGroups
- The list of pending security groups to authorize connections to brokers.
$sel:subnetIds:DescribeBrokerResponse'
, describeBrokerResponse_subnetIds
- The list of groups that define which subnets and IP ranges the broker
can use from different Availability Zones.
$sel:created:DescribeBrokerResponse'
, describeBrokerResponse_created
- The time when the broker was created.
$sel:configurations:DescribeBrokerResponse'
, describeBrokerResponse_configurations
- The list of all revisions for the specified configuration.
$sel:authenticationStrategy:DescribeBrokerResponse'
, describeBrokerResponse_authenticationStrategy
- The authentication strategy used to secure the broker. The default is
SIMPLE.
$sel:pendingHostInstanceType:DescribeBrokerResponse'
, describeBrokerResponse_pendingHostInstanceType
- The broker's host instance type to upgrade to. For a list of supported
instance types, see
Broker instance types.
$sel:ldapServerMetadata:DescribeBrokerResponse'
, describeBrokerResponse_ldapServerMetadata
- The metadata of the LDAP server used to authenticate and authorize
connections to the broker.
$sel:maintenanceWindowStartTime:DescribeBrokerResponse'
, describeBrokerResponse_maintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.
$sel:logs:DescribeBrokerResponse'
, describeBrokerResponse_logs
- The list of information about logs currently enabled and pending to be
deployed for the specified broker.
$sel:encryptionOptions:DescribeBrokerResponse'
, describeBrokerResponse_encryptionOptions
- Encryption options for the broker. Does not apply to RabbitMQ brokers.
$sel:deploymentMode:DescribeBrokerResponse'
, describeBrokerResponse_deploymentMode
- The broker's deployment mode.
$sel:pendingEngineVersion:DescribeBrokerResponse'
, describeBrokerResponse_pendingEngineVersion
- The broker engine version to upgrade to. For a list of supported engine
versions, see
Supported engines.
$sel:brokerId:DescribeBroker'
, describeBrokerResponse_brokerId
- The unique ID that Amazon MQ generates for the broker.
$sel:pendingLdapServerMetadata:DescribeBrokerResponse'
, describeBrokerResponse_pendingLdapServerMetadata
- The metadata of the LDAP server that will be used to authenticate and
authorize connections to the broker after it is rebooted.
$sel:engineType:DescribeBrokerResponse'
, describeBrokerResponse_engineType
- The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and
RABBITMQ.
$sel:brokerArn:DescribeBrokerResponse'
, describeBrokerResponse_brokerArn
- The broker's Amazon Resource Name (ARN).
$sel:tags:DescribeBrokerResponse'
, describeBrokerResponse_tags
- The list of all tags associated with this broker.
$sel:brokerInstances:DescribeBrokerResponse'
, describeBrokerResponse_brokerInstances
- A list of information about allocated brokers.
$sel:hostInstanceType:DescribeBrokerResponse'
, describeBrokerResponse_hostInstanceType
- The broker's instance type.
$sel:storageType:DescribeBrokerResponse'
, describeBrokerResponse_storageType
- The broker's storage type.
$sel:httpStatus:DescribeBrokerResponse'
, describeBrokerResponse_httpStatus
- The response's http status code.
Response Lenses
describeBrokerResponse_brokerName :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker's name. This value must be unique in your AWS 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.
describeBrokerResponse_engineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker engine's version. For a list of supported engine versions, see Supported engines.
describeBrokerResponse_pendingAuthenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #
The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
describeBrokerResponse_brokerState :: Lens' DescribeBrokerResponse (Maybe BrokerState) Source #
The broker's status.
describeBrokerResponse_publiclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool) Source #
Enables connections from applications outside of the VPC that hosts the broker's subnets.
describeBrokerResponse_autoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool) Source #
Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
describeBrokerResponse_securityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #
The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
describeBrokerResponse_users :: Lens' DescribeBrokerResponse (Maybe [UserSummary]) Source #
The list of all broker usernames for the specified broker.
describeBrokerResponse_pendingSecurityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #
The list of pending security groups to authorize connections to brokers.
describeBrokerResponse_subnetIds :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
describeBrokerResponse_created :: Lens' DescribeBrokerResponse (Maybe UTCTime) Source #
The time when the broker was created.
describeBrokerResponse_configurations :: Lens' DescribeBrokerResponse (Maybe Configurations) Source #
The list of all revisions for the specified configuration.
describeBrokerResponse_authenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #
The authentication strategy used to secure the broker. The default is SIMPLE.
describeBrokerResponse_pendingHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
describeBrokerResponse_ldapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #
The metadata of the LDAP server used to authenticate and authorize connections to the broker.
describeBrokerResponse_maintenanceWindowStartTime :: Lens' DescribeBrokerResponse (Maybe WeeklyStartTime) Source #
The parameters that determine the WeeklyStartTime.
describeBrokerResponse_logs :: Lens' DescribeBrokerResponse (Maybe LogsSummary) Source #
The list of information about logs currently enabled and pending to be deployed for the specified broker.
describeBrokerResponse_encryptionOptions :: Lens' DescribeBrokerResponse (Maybe EncryptionOptions) Source #
Encryption options for the broker. Does not apply to RabbitMQ brokers.
describeBrokerResponse_deploymentMode :: Lens' DescribeBrokerResponse (Maybe DeploymentMode) Source #
The broker's deployment mode.
describeBrokerResponse_pendingEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
describeBrokerResponse_brokerId :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The unique ID that Amazon MQ generates for the broker.
describeBrokerResponse_pendingLdapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #
The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
describeBrokerResponse_engineType :: Lens' DescribeBrokerResponse (Maybe EngineType) Source #
The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
describeBrokerResponse_brokerArn :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker's Amazon Resource Name (ARN).
describeBrokerResponse_tags :: Lens' DescribeBrokerResponse (Maybe (HashMap Text Text)) Source #
The list of all tags associated with this broker.
describeBrokerResponse_brokerInstances :: Lens' DescribeBrokerResponse (Maybe [BrokerInstance]) Source #
A list of information about allocated brokers.
describeBrokerResponse_hostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker's instance type.
describeBrokerResponse_storageType :: Lens' DescribeBrokerResponse (Maybe BrokerStorageType) Source #
The broker's storage type.
describeBrokerResponse_httpStatus :: Lens' DescribeBrokerResponse Int Source #
The response's http status code.