Network.AWS.MQ.CreateBroker

Creates a broker. Note: This API is asynchronous.

Creating a Request

createBroker :: CreateBroker

Creates a value of CreateBroker with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cbBrokerName - Required. 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.
• cbEngineVersion - Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
• cbPubliclyAccessible - Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
• cbAutoMinorVersionUpgrade - 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.
• cbSecurityGroups - Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
• cbUsers - Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
• cbSubnetIds - Required. 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.
• cbCreatorRequestId - The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
• cbMaintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
• cbDeploymentMode - 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.
• cbConfiguration - A list of information about the configuration.
• cbEngineType - Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
• cbHostInstanceType - Required. The broker's instance type. Possible values: mq.t2.micro, mq.m4.large

data CreateBroker

Creates a broker using the specified properties.

See: createBroker smart constructor.

Instances

Eq CreateBroker

Methods

(==) :: CreateBroker -> CreateBroker -> Bool

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

Data CreateBroker

Methods

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

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

toConstr :: CreateBroker -> Constr

dataTypeOf :: CreateBroker -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateBroker

Methods

readsPrec :: Int -> ReadS CreateBroker

readList :: ReadS [CreateBroker]

readPrec :: ReadPrec CreateBroker

readListPrec :: ReadPrec [CreateBroker]

Show CreateBroker

Methods

showsPrec :: Int -> CreateBroker -> ShowS

show :: CreateBroker -> String

showList :: [CreateBroker] -> ShowS

Generic CreateBroker

Associated Types

type Rep CreateBroker :: * -> *

Methods

from :: CreateBroker -> Rep CreateBroker x

to :: Rep CreateBroker x -> CreateBroker

Hashable CreateBroker

Methods

hashWithSalt :: Int -> CreateBroker -> Int

hash :: CreateBroker -> Int

ToJSON CreateBroker

Methods

toJSON :: CreateBroker -> Value

toEncoding :: CreateBroker -> Encoding

toJSONList :: [CreateBroker] -> Value

toEncodingList :: [CreateBroker] -> Encoding

NFData CreateBroker

Methods

rnf :: CreateBroker -> ()

AWSRequest CreateBroker

Associated Types

type Rs CreateBroker :: *

Methods

request :: CreateBroker -> Request CreateBroker

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

ToHeaders CreateBroker

Methods

toHeaders :: CreateBroker -> [Header]

ToPath CreateBroker

Methods

toPath :: CreateBroker -> ByteString

ToQuery CreateBroker

Methods

toQuery :: CreateBroker -> QueryString

type Rep CreateBroker

type Rep CreateBroker = D1 * (MetaData "CreateBroker" "Network.AWS.MQ.CreateBroker" "amazonka-mq-1.6.0-2p1A05IoaUzMnRutMRqns" False) (C1 * (MetaCons "CreateBroker'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cbBrokerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbEngineVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbPubliclyAccessible") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbAutoMinorVersionUpgrade") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_cbUsers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [User])))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cbSubnetIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbCreatorRequestId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbMaintenanceWindowStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe WeeklyStartTime))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cbDeploymentMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DeploymentMode))) (S1 * (MetaSel (Just Symbol "_cbConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ConfigurationId)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbEngineType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe EngineType))) (S1 * (MetaSel (Just Symbol "_cbHostInstanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))))))

type Rs CreateBroker

type Rs CreateBroker = CreateBrokerResponse

Request Lenses

cbBrokerName :: Lens' CreateBroker (Maybe Text)

Required. 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.

cbEngineVersion :: Lens' CreateBroker (Maybe Text)

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

cbPubliclyAccessible :: Lens' CreateBroker (Maybe Bool)

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

cbAutoMinorVersionUpgrade :: Lens' CreateBroker (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.

cbSecurityGroups :: Lens' CreateBroker [Text]

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

cbUsers :: Lens' CreateBroker [User]

Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.

cbSubnetIds :: Lens' CreateBroker [Text]

Required. 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.

cbCreatorRequestId :: Lens' CreateBroker (Maybe Text)

The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.

cbMaintenanceWindowStartTime :: Lens' CreateBroker (Maybe WeeklyStartTime)

The parameters that determine the WeeklyStartTime.

cbDeploymentMode :: Lens' CreateBroker (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.

cbConfiguration :: Lens' CreateBroker (Maybe ConfigurationId)

A list of information about the configuration.

cbEngineType :: Lens' CreateBroker (Maybe EngineType)

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

cbHostInstanceType :: Lens' CreateBroker (Maybe Text)

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

Destructuring the Response

createBrokerResponse

Arguments

:: Int

cbrsResponseStatus

-> CreateBrokerResponse

Creates a value of CreateBrokerResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cbrsBrokerId - The unique ID that Amazon MQ generates for the broker.
• cbrsBrokerARN - The Amazon Resource Name (ARN) of the broker.
• cbrsResponseStatus - -- | The response status code.

data CreateBrokerResponse

See: createBrokerResponse smart constructor.

Instances

Eq CreateBrokerResponse

Methods

(==) :: CreateBrokerResponse -> CreateBrokerResponse -> Bool

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

Data CreateBrokerResponse

Methods

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

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

toConstr :: CreateBrokerResponse -> Constr

dataTypeOf :: CreateBrokerResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateBrokerResponse

Methods

readsPrec :: Int -> ReadS CreateBrokerResponse

readList :: ReadS [CreateBrokerResponse]

readPrec :: ReadPrec CreateBrokerResponse

readListPrec :: ReadPrec [CreateBrokerResponse]

Show CreateBrokerResponse

Methods

showsPrec :: Int -> CreateBrokerResponse -> ShowS

show :: CreateBrokerResponse -> String

showList :: [CreateBrokerResponse] -> ShowS

Generic CreateBrokerResponse

Associated Types

type Rep CreateBrokerResponse :: * -> *

Methods

from :: CreateBrokerResponse -> Rep CreateBrokerResponse x

to :: Rep CreateBrokerResponse x -> CreateBrokerResponse

NFData CreateBrokerResponse

Methods

rnf :: CreateBrokerResponse -> ()

type Rep CreateBrokerResponse

type Rep CreateBrokerResponse = D1 * (MetaData "CreateBrokerResponse" "Network.AWS.MQ.CreateBroker" "amazonka-mq-1.6.0-2p1A05IoaUzMnRutMRqns" False) (C1 * (MetaCons "CreateBrokerResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbrsBrokerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbrsBrokerARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

cbrsBrokerId :: Lens' CreateBrokerResponse (Maybe Text)

The unique ID that Amazon MQ generates for the broker.

cbrsBrokerARN :: Lens' CreateBrokerResponse (Maybe Text)

The Amazon Resource Name (ARN) of the broker.

cbrsResponseStatus :: Lens' CreateBrokerResponse Int

• - | The response status code.