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 |
Creates a broker. Note: This API is asynchronous.
Synopsis
- createBroker :: CreateBroker
- data CreateBroker
- cbBrokerName :: Lens' CreateBroker (Maybe Text)
- cbEngineVersion :: Lens' CreateBroker (Maybe Text)
- cbPubliclyAccessible :: Lens' CreateBroker (Maybe Bool)
- cbAutoMinorVersionUpgrade :: Lens' CreateBroker (Maybe Bool)
- cbSecurityGroups :: Lens' CreateBroker [Text]
- cbUsers :: Lens' CreateBroker [User]
- cbSubnetIds :: Lens' CreateBroker [Text]
- cbCreatorRequestId :: Lens' CreateBroker (Maybe Text)
- cbMaintenanceWindowStartTime :: Lens' CreateBroker (Maybe WeeklyStartTime)
- cbDeploymentMode :: Lens' CreateBroker (Maybe DeploymentMode)
- cbConfiguration :: Lens' CreateBroker (Maybe ConfigurationId)
- cbEngineType :: Lens' CreateBroker (Maybe EngineType)
- cbHostInstanceType :: Lens' CreateBroker (Maybe Text)
- createBrokerResponse :: Int -> CreateBrokerResponse
- data CreateBrokerResponse
- cbrsBrokerId :: Lens' CreateBrokerResponse (Maybe Text)
- cbrsBrokerARN :: Lens' CreateBrokerResponse (Maybe Text)
- cbrsResponseStatus :: Lens' CreateBrokerResponse Int
Creating a Request
createBroker :: CreateBroker Source #
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 Source #
Creates a broker using the specified properties.
See: createBroker
smart constructor.
Instances
Request Lenses
cbBrokerName :: Lens' CreateBroker (Maybe Text) Source #
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) Source #
Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.
cbPubliclyAccessible :: Lens' CreateBroker (Maybe Bool) Source #
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
cbAutoMinorVersionUpgrade :: Lens' CreateBroker (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.
cbSecurityGroups :: Lens' CreateBroker [Text] Source #
Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
cbUsers :: Lens' CreateBroker [User] Source #
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] Source #
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) Source #
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) Source #
The parameters that determine the WeeklyStartTime.
cbDeploymentMode :: Lens' CreateBroker (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.
cbConfiguration :: Lens' CreateBroker (Maybe ConfigurationId) Source #
A list of information about the configuration.
cbEngineType :: Lens' CreateBroker (Maybe EngineType) Source #
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
cbHostInstanceType :: Lens' CreateBroker (Maybe Text) Source #
Required. The broker's instance type. Possible values: mq.t2.micro, mq.m4.large
Destructuring the Response
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 Source #
See: createBrokerResponse
smart constructor.
Instances
Response Lenses
cbrsBrokerId :: Lens' CreateBrokerResponse (Maybe Text) Source #
The unique ID that Amazon MQ generates for the broker.
cbrsBrokerARN :: Lens' CreateBrokerResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the broker.
cbrsResponseStatus :: Lens' CreateBrokerResponse Int Source #
- - | The response status code.