Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns information about the specified broker.
Synopsis
- describeBroker :: Text -> DescribeBroker
- data DescribeBroker
- desBrokerId :: Lens' DescribeBroker Text
- describeBrokerResponse :: Int -> DescribeBrokerResponse
- data DescribeBrokerResponse
- dbrsBrokerName :: Lens' DescribeBrokerResponse (Maybe Text)
- dbrsEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text)
- dbrsBrokerState :: Lens' DescribeBrokerResponse (Maybe BrokerState)
- dbrsPubliclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool)
- dbrsAutoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool)
- dbrsSecurityGroups :: Lens' DescribeBrokerResponse [Text]
- dbrsUsers :: Lens' DescribeBrokerResponse [UserSummary]
- dbrsSubnetIds :: Lens' DescribeBrokerResponse [Text]
- dbrsConfigurations :: Lens' DescribeBrokerResponse (Maybe Configurations)
- dbrsMaintenanceWindowStartTime :: Lens' DescribeBrokerResponse (Maybe WeeklyStartTime)
- dbrsDeploymentMode :: Lens' DescribeBrokerResponse (Maybe DeploymentMode)
- dbrsBrokerId :: Lens' DescribeBrokerResponse (Maybe Text)
- dbrsEngineType :: Lens' DescribeBrokerResponse (Maybe EngineType)
- dbrsBrokerARN :: Lens' DescribeBrokerResponse (Maybe Text)
- dbrsBrokerInstances :: Lens' DescribeBrokerResponse [BrokerInstance]
- dbrsHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text)
- dbrsResponseStatus :: Lens' DescribeBrokerResponse Int
Creating a Request
Creates a value of DescribeBroker
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
desBrokerId
- The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.
data DescribeBroker Source #
See: describeBroker
smart constructor.
Instances
Request Lenses
desBrokerId :: Lens' DescribeBroker Text Source #
The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.
Destructuring the Response
describeBrokerResponse Source #
Creates a value of DescribeBrokerResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dbrsBrokerName
- The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.dbrsEngineVersion
- The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.dbrsBrokerState
- The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESSdbrsPubliclyAccessible
- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.dbrsAutoMinorVersionUpgrade
- Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.dbrsSecurityGroups
- Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.dbrsUsers
- The list of all ActiveMQ usernames for the specified broker.dbrsSubnetIds
- The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.dbrsConfigurations
- The list of all revisions for the specified configuration.dbrsMaintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.dbrsDeploymentMode
- Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.dbrsBrokerId
- The unique ID that Amazon MQ generates for the broker.dbrsEngineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.dbrsBrokerARN
- The Amazon Resource Name (ARN) of the broker.dbrsBrokerInstances
- A list of information about allocated brokers.dbrsHostInstanceType
- The broker's instance type. Possible values: mq.t2.micro, mq.m4.largedbrsResponseStatus
- -- | The response status code.
data DescribeBrokerResponse Source #
See: describeBrokerResponse
smart constructor.
Instances
Response Lenses
dbrsBrokerName :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The name of the broker. 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 whitespaces, brackets, wildcard characters, or special characters.
dbrsEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
dbrsBrokerState :: Lens' DescribeBrokerResponse (Maybe BrokerState) Source #
The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS
dbrsPubliclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool) Source #
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
dbrsAutoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool) Source #
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
dbrsSecurityGroups :: Lens' DescribeBrokerResponse [Text] Source #
Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
dbrsUsers :: Lens' DescribeBrokerResponse [UserSummary] Source #
The list of all ActiveMQ usernames for the specified broker.
dbrsSubnetIds :: Lens' DescribeBrokerResponse [Text] Source #
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
dbrsConfigurations :: Lens' DescribeBrokerResponse (Maybe Configurations) Source #
The list of all revisions for the specified configuration.
dbrsMaintenanceWindowStartTime :: Lens' DescribeBrokerResponse (Maybe WeeklyStartTime) Source #
The parameters that determine the WeeklyStartTime.
dbrsDeploymentMode :: Lens' DescribeBrokerResponse (Maybe DeploymentMode) Source #
Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ creates an active/standby broker for high availability.
dbrsBrokerId :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The unique ID that Amazon MQ generates for the broker.
dbrsEngineType :: Lens' DescribeBrokerResponse (Maybe EngineType) Source #
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
dbrsBrokerARN :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the broker.
dbrsBrokerInstances :: Lens' DescribeBrokerResponse [BrokerInstance] Source #
A list of information about allocated brokers.
dbrsHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #
The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
dbrsResponseStatus :: Lens' DescribeBrokerResponse Int Source #
- - | The response status code.