Network.AWS.MQ.DescribeBroker

Returns information about the specified broker.

Creating a Request

describeBroker

Arguments

:: Text

desBrokerId

-> DescribeBroker

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

See: describeBroker smart constructor.

Instances

Eq DescribeBroker

Methods

(==) :: DescribeBroker -> DescribeBroker -> Bool

(/=) :: DescribeBroker -> DescribeBroker -> Bool

Data DescribeBroker

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeBroker -> c DescribeBroker

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeBroker

toConstr :: DescribeBroker -> Constr

dataTypeOf :: DescribeBroker -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeBroker)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeBroker)

gmapT :: (forall b. Data b => b -> b) -> DescribeBroker -> DescribeBroker

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBroker -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBroker -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeBroker -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeBroker -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeBroker -> m DescribeBroker

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBroker -> m DescribeBroker

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBroker -> m DescribeBroker

Read DescribeBroker

Methods

readsPrec :: Int -> ReadS DescribeBroker

readList :: ReadS [DescribeBroker]

readPrec :: ReadPrec DescribeBroker

readListPrec :: ReadPrec [DescribeBroker]

Show DescribeBroker

Methods

showsPrec :: Int -> DescribeBroker -> ShowS

show :: DescribeBroker -> String

showList :: [DescribeBroker] -> ShowS

Generic DescribeBroker

Associated Types

type Rep DescribeBroker :: * -> *

Methods

from :: DescribeBroker -> Rep DescribeBroker x

to :: Rep DescribeBroker x -> DescribeBroker

Hashable DescribeBroker

Methods

hashWithSalt :: Int -> DescribeBroker -> Int

hash :: DescribeBroker -> Int

NFData DescribeBroker

Methods

rnf :: DescribeBroker -> ()

AWSRequest DescribeBroker

Associated Types

type Rs DescribeBroker :: *

Methods

request :: DescribeBroker -> Request DescribeBroker

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeBroker -> ClientResponse -> m (Response DescribeBroker)

ToHeaders DescribeBroker

Methods

toHeaders :: DescribeBroker -> [Header]

ToPath DescribeBroker

Methods

toPath :: DescribeBroker -> ByteString

ToQuery DescribeBroker

Methods

toQuery :: DescribeBroker -> QueryString

type Rep DescribeBroker

type Rep DescribeBroker = D1 * (MetaData "DescribeBroker" "Network.AWS.MQ.DescribeBroker" "amazonka-mq-1.6.0-2p1A05IoaUzMnRutMRqns" True) (C1 * (MetaCons "DescribeBroker'" PrefixI True) (S1 * (MetaSel (Just Symbol "_desBrokerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DescribeBroker

type Rs DescribeBroker = DescribeBrokerResponse

Request Lenses

desBrokerId :: Lens' DescribeBroker Text

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

Arguments

:: Int

dbrsResponseStatus

-> DescribeBrokerResponse

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_PROGRESS
• dbrsPubliclyAccessible - 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.large
• dbrsResponseStatus - -- | The response status code.

data DescribeBrokerResponse

See: describeBrokerResponse smart constructor.

Instances

Eq DescribeBrokerResponse

Methods

(==) :: DescribeBrokerResponse -> DescribeBrokerResponse -> Bool

(/=) :: DescribeBrokerResponse -> DescribeBrokerResponse -> Bool

Data DescribeBrokerResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeBrokerResponse -> c DescribeBrokerResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeBrokerResponse

toConstr :: DescribeBrokerResponse -> Constr

dataTypeOf :: DescribeBrokerResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeBrokerResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeBrokerResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeBrokerResponse -> DescribeBrokerResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBrokerResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeBrokerResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeBrokerResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeBrokerResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeBrokerResponse -> m DescribeBrokerResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBrokerResponse -> m DescribeBrokerResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeBrokerResponse -> m DescribeBrokerResponse

Read DescribeBrokerResponse

Methods

readsPrec :: Int -> ReadS DescribeBrokerResponse

readList :: ReadS [DescribeBrokerResponse]

readPrec :: ReadPrec DescribeBrokerResponse

readListPrec :: ReadPrec [DescribeBrokerResponse]

Show DescribeBrokerResponse

Methods

showsPrec :: Int -> DescribeBrokerResponse -> ShowS

show :: DescribeBrokerResponse -> String

showList :: [DescribeBrokerResponse] -> ShowS

Generic DescribeBrokerResponse

Associated Types

type Rep DescribeBrokerResponse :: * -> *

Methods

from :: DescribeBrokerResponse -> Rep DescribeBrokerResponse x

to :: Rep DescribeBrokerResponse x -> DescribeBrokerResponse

NFData DescribeBrokerResponse

Methods

rnf :: DescribeBrokerResponse -> ()

type Rep DescribeBrokerResponse

type Rep DescribeBrokerResponse = D1 * (MetaData "DescribeBrokerResponse" "Network.AWS.MQ.DescribeBroker" "amazonka-mq-1.6.0-2p1A05IoaUzMnRutMRqns" False) (C1 * (MetaCons "DescribeBrokerResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsBrokerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dbrsEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsBrokerState") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe BrokerState))) (S1 * (MetaSel (Just Symbol "_dbrsPubliclyAccessible") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsAutoMinorVersionUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_dbrsSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [UserSummary]))) (S1 * (MetaSel (Just Symbol "_dbrsSubnetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text])))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsConfigurations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Configurations))) (S1 * (MetaSel (Just Symbol "_dbrsMaintenanceWindowStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe WeeklyStartTime)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsDeploymentMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DeploymentMode))) (S1 * (MetaSel (Just Symbol "_dbrsBrokerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsEngineType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EngineType))) (S1 * (MetaSel (Just Symbol "_dbrsBrokerARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsBrokerInstances") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [BrokerInstance]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dbrsHostInstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))))))

Response Lenses

dbrsBrokerName :: Lens' DescribeBrokerResponse (Maybe Text)

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)

The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.

dbrsBrokerState :: Lens' DescribeBrokerResponse (Maybe BrokerState)

The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS, RUNNING, REBOOT_IN_PROGRESS

dbrsPubliclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool)

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

dbrsAutoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool)

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]

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

dbrsUsers :: Lens' DescribeBrokerResponse [UserSummary]

The list of all ActiveMQ usernames for the specified broker.

dbrsSubnetIds :: Lens' DescribeBrokerResponse [Text]

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)

The list of all revisions for the specified configuration.

dbrsMaintenanceWindowStartTime :: Lens' DescribeBrokerResponse (Maybe WeeklyStartTime)

The parameters that determine the WeeklyStartTime.

dbrsDeploymentMode :: Lens' DescribeBrokerResponse (Maybe DeploymentMode)

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)

The unique ID that Amazon MQ generates for the broker.

dbrsEngineType :: Lens' DescribeBrokerResponse (Maybe EngineType)

Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.

dbrsBrokerARN :: Lens' DescribeBrokerResponse (Maybe Text)

The Amazon Resource Name (ARN) of the broker.

dbrsBrokerInstances :: Lens' DescribeBrokerResponse [BrokerInstance]

A list of information about allocated brokers.

dbrsHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text)

The broker's instance type. Possible values: mq.t2.micro, mq.m4.large

dbrsResponseStatus :: Lens' DescribeBrokerResponse Int

• - | The response status code.