| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MQ
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateBroker
- CreateConfiguration
- CreateTags
- CreateUser
- DeleteBroker
- DeleteTags
- DeleteUser
- DescribeBroker
- DescribeBrokerEngineTypes
- DescribeBrokerInstanceOptions
- DescribeConfiguration
- DescribeConfigurationRevision
- DescribeUser
- ListBrokers (Paginated)
- ListConfigurationRevisions
- ListConfigurations
- ListTags
- ListUsers
- RebootBroker
- UpdateBroker
- UpdateConfiguration
- UpdateUser
- Types
- AuthenticationStrategy
- BrokerState
- BrokerStorageType
- ChangeType
- DayOfWeek
- DeploymentMode
- EngineType
- SanitizationWarningReason
- ActionRequired
- AvailabilityZone
- BrokerEngineType
- BrokerInstance
- BrokerInstanceOption
- BrokerSummary
- Configuration
- ConfigurationId
- ConfigurationRevision
- Configurations
- EncryptionOptions
- EngineVersion
- LdapServerMetadataInput
- LdapServerMetadataOutput
- Logs
- LogsSummary
- PendingLogs
- SanitizationWarning
- User
- UserPendingChanges
- UserSummary
- WeeklyStartTime
Description
Derived from API version 2017-11-27 of the AWS service descriptions, licensed under Apache 2.0.
Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _ForbiddenException :: AsError a => Fold a ServiceError
- _InternalServerErrorException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- data CreateBroker = CreateBroker' (Maybe AuthenticationStrategy) (Maybe ConfigurationId) (Maybe Text) (Maybe EncryptionOptions) (Maybe LdapServerMetadataInput) (Maybe Logs) (Maybe WeeklyStartTime) (Maybe [Text]) (Maybe BrokerStorageType) (Maybe [Text]) (Maybe (HashMap Text Text)) Text Text Bool [User] Text DeploymentMode EngineType Bool
- newCreateBroker :: Text -> Text -> Bool -> Text -> DeploymentMode -> EngineType -> Bool -> CreateBroker
- data CreateBrokerResponse = CreateBrokerResponse' (Maybe Text) (Maybe Text) Int
- newCreateBrokerResponse :: Int -> CreateBrokerResponse
- data CreateConfiguration = CreateConfiguration' (Maybe AuthenticationStrategy) (Maybe (HashMap Text Text)) Text EngineType Text
- newCreateConfiguration :: Text -> EngineType -> Text -> CreateConfiguration
- data CreateConfigurationResponse = CreateConfigurationResponse' (Maybe Text) (Maybe AuthenticationStrategy) (Maybe ISO8601) (Maybe Text) (Maybe ConfigurationRevision) (Maybe Text) Int
- newCreateConfigurationResponse :: Int -> CreateConfigurationResponse
- data CreateTags = CreateTags' (Maybe (HashMap Text Text)) Text
- newCreateTags :: Text -> CreateTags
- data CreateTagsResponse = CreateTagsResponse' {
- newCreateTagsResponse :: CreateTagsResponse
- data CreateUser = CreateUser' (Maybe Bool) (Maybe [Text]) Text Text Text
- newCreateUser :: Text -> Text -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data DeleteBroker = DeleteBroker' Text
- newDeleteBroker :: Text -> DeleteBroker
- data DeleteBrokerResponse = DeleteBrokerResponse' (Maybe Text) Int
- newDeleteBrokerResponse :: Int -> DeleteBrokerResponse
- data DeleteTags = DeleteTags' [Text] Text
- newDeleteTags :: Text -> DeleteTags
- data DeleteTagsResponse = DeleteTagsResponse' {
- newDeleteTagsResponse :: DeleteTagsResponse
- data DeleteUser = DeleteUser' Text Text
- newDeleteUser :: Text -> Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' Int
- newDeleteUserResponse :: Int -> DeleteUserResponse
- data DescribeBroker = DescribeBroker' Text
- newDescribeBroker :: Text -> DescribeBroker
- data DescribeBrokerResponse = DescribeBrokerResponse' (Maybe [ActionRequired]) (Maybe AuthenticationStrategy) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [BrokerInstance]) (Maybe Text) (Maybe BrokerState) (Maybe Configurations) (Maybe ISO8601) (Maybe DeploymentMode) (Maybe EncryptionOptions) (Maybe EngineType) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataOutput) (Maybe LogsSummary) (Maybe WeeklyStartTime) (Maybe AuthenticationStrategy) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataOutput) (Maybe [Text]) (Maybe Bool) (Maybe [Text]) (Maybe BrokerStorageType) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe [UserSummary]) Int
- newDescribeBrokerResponse :: Int -> DescribeBrokerResponse
- data DescribeBrokerEngineTypes = DescribeBrokerEngineTypes' (Maybe Text) (Maybe Natural) (Maybe Text)
- newDescribeBrokerEngineTypes :: DescribeBrokerEngineTypes
- data DescribeBrokerEngineTypesResponse = DescribeBrokerEngineTypesResponse' (Maybe [BrokerEngineType]) (Maybe Natural) (Maybe Text) Int
- newDescribeBrokerEngineTypesResponse :: Int -> DescribeBrokerEngineTypesResponse
- data DescribeBrokerInstanceOptions = DescribeBrokerInstanceOptions' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text)
- newDescribeBrokerInstanceOptions :: DescribeBrokerInstanceOptions
- data DescribeBrokerInstanceOptionsResponse = DescribeBrokerInstanceOptionsResponse' (Maybe [BrokerInstanceOption]) (Maybe Natural) (Maybe Text) Int
- newDescribeBrokerInstanceOptionsResponse :: Int -> DescribeBrokerInstanceOptionsResponse
- data DescribeConfiguration = DescribeConfiguration' Text
- newDescribeConfiguration :: Text -> DescribeConfiguration
- data DescribeConfigurationResponse = DescribeConfigurationResponse' (Maybe Text) (Maybe AuthenticationStrategy) (Maybe ISO8601) (Maybe Text) (Maybe EngineType) (Maybe Text) (Maybe Text) (Maybe ConfigurationRevision) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newDescribeConfigurationResponse :: Int -> DescribeConfigurationResponse
- data DescribeConfigurationRevision = DescribeConfigurationRevision' Text Text
- newDescribeConfigurationRevision :: Text -> Text -> DescribeConfigurationRevision
- data DescribeConfigurationRevisionResponse = DescribeConfigurationRevisionResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) Int
- newDescribeConfigurationRevisionResponse :: Int -> DescribeConfigurationRevisionResponse
- data DescribeUser = DescribeUser' Text Text
- newDescribeUser :: Text -> Text -> DescribeUser
- data DescribeUserResponse = DescribeUserResponse' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe UserPendingChanges) (Maybe Text) Int
- newDescribeUserResponse :: Int -> DescribeUserResponse
- data ListBrokers = ListBrokers' (Maybe Natural) (Maybe Text)
- newListBrokers :: ListBrokers
- data ListBrokersResponse = ListBrokersResponse' (Maybe [BrokerSummary]) (Maybe Text) Int
- newListBrokersResponse :: Int -> ListBrokersResponse
- data ListConfigurationRevisions = ListConfigurationRevisions' (Maybe Natural) (Maybe Text) Text
- newListConfigurationRevisions :: Text -> ListConfigurationRevisions
- data ListConfigurationRevisionsResponse = ListConfigurationRevisionsResponse' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [ConfigurationRevision]) Int
- newListConfigurationRevisionsResponse :: Int -> ListConfigurationRevisionsResponse
- data ListConfigurations = ListConfigurations' (Maybe Natural) (Maybe Text)
- newListConfigurations :: ListConfigurations
- data ListConfigurationsResponse = ListConfigurationsResponse' (Maybe [Configuration]) (Maybe Int) (Maybe Text) Int
- newListConfigurationsResponse :: Int -> ListConfigurationsResponse
- data ListTags = ListTags' Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe (HashMap Text Text)) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data ListUsers = ListUsers' (Maybe Natural) (Maybe Text) Text
- newListUsers :: Text -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [UserSummary]) Int
- newListUsersResponse :: Int -> ListUsersResponse
- data RebootBroker = RebootBroker' Text
- newRebootBroker :: Text -> RebootBroker
- data RebootBrokerResponse = RebootBrokerResponse' Int
- newRebootBrokerResponse :: Int -> RebootBrokerResponse
- data UpdateBroker = UpdateBroker' (Maybe AuthenticationStrategy) (Maybe Bool) (Maybe ConfigurationId) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataInput) (Maybe Logs) (Maybe WeeklyStartTime) (Maybe [Text]) Text
- newUpdateBroker :: Text -> UpdateBroker
- data UpdateBrokerResponse = UpdateBrokerResponse' (Maybe AuthenticationStrategy) (Maybe Bool) (Maybe Text) (Maybe ConfigurationId) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataOutput) (Maybe Logs) (Maybe WeeklyStartTime) (Maybe [Text]) Int
- newUpdateBrokerResponse :: Int -> UpdateBrokerResponse
- data UpdateConfiguration = UpdateConfiguration' (Maybe Text) Text Text
- newUpdateConfiguration :: Text -> Text -> UpdateConfiguration
- data UpdateConfigurationResponse = UpdateConfigurationResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ConfigurationRevision) (Maybe Text) (Maybe [SanitizationWarning]) Int
- newUpdateConfigurationResponse :: Int -> UpdateConfigurationResponse
- data UpdateUser = UpdateUser' (Maybe Bool) (Maybe [Text]) (Maybe Text) Text Text
- newUpdateUser :: Text -> Text -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- newtype AuthenticationStrategy where
- newtype BrokerState where
- BrokerState' { }
- pattern BrokerState_CREATION_FAILED :: BrokerState
- pattern BrokerState_CREATION_IN_PROGRESS :: BrokerState
- pattern BrokerState_CRITICAL_ACTION_REQUIRED :: BrokerState
- pattern BrokerState_DELETION_IN_PROGRESS :: BrokerState
- pattern BrokerState_REBOOT_IN_PROGRESS :: BrokerState
- pattern BrokerState_RUNNING :: BrokerState
- newtype BrokerStorageType where
- BrokerStorageType' { }
- pattern BrokerStorageType_EBS :: BrokerStorageType
- pattern BrokerStorageType_EFS :: BrokerStorageType
- newtype ChangeType where
- ChangeType' { }
- pattern ChangeType_CREATE :: ChangeType
- pattern ChangeType_DELETE :: ChangeType
- pattern ChangeType_UPDATE :: ChangeType
- newtype DayOfWeek where
- DayOfWeek' { }
- pattern DayOfWeek_FRIDAY :: DayOfWeek
- pattern DayOfWeek_MONDAY :: DayOfWeek
- pattern DayOfWeek_SATURDAY :: DayOfWeek
- pattern DayOfWeek_SUNDAY :: DayOfWeek
- pattern DayOfWeek_THURSDAY :: DayOfWeek
- pattern DayOfWeek_TUESDAY :: DayOfWeek
- pattern DayOfWeek_WEDNESDAY :: DayOfWeek
- newtype DeploymentMode where
- DeploymentMode' { }
- pattern DeploymentMode_ACTIVE_STANDBY_MULTI_AZ :: DeploymentMode
- pattern DeploymentMode_CLUSTER_MULTI_AZ :: DeploymentMode
- pattern DeploymentMode_SINGLE_INSTANCE :: DeploymentMode
- newtype EngineType where
- EngineType' { }
- pattern EngineType_ACTIVEMQ :: EngineType
- pattern EngineType_RABBITMQ :: EngineType
- newtype SanitizationWarningReason where
- SanitizationWarningReason' { }
- pattern SanitizationWarningReason_DISALLOWED_ATTRIBUTE_REMOVED :: SanitizationWarningReason
- pattern SanitizationWarningReason_DISALLOWED_ELEMENT_REMOVED :: SanitizationWarningReason
- pattern SanitizationWarningReason_INVALID_ATTRIBUTE_VALUE_REMOVED :: SanitizationWarningReason
- data ActionRequired = ActionRequired' (Maybe Text) (Maybe Text)
- newActionRequired :: ActionRequired
- data AvailabilityZone = AvailabilityZone' (Maybe Text)
- newAvailabilityZone :: AvailabilityZone
- data BrokerEngineType = BrokerEngineType' (Maybe EngineType) (Maybe [EngineVersion])
- newBrokerEngineType :: BrokerEngineType
- data BrokerInstance = BrokerInstance' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newBrokerInstance :: BrokerInstance
- data BrokerInstanceOption = BrokerInstanceOption' (Maybe [AvailabilityZone]) (Maybe EngineType) (Maybe Text) (Maybe BrokerStorageType) (Maybe [DeploymentMode]) (Maybe [Text])
- newBrokerInstanceOption :: BrokerInstanceOption
- data BrokerSummary = BrokerSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe BrokerState) (Maybe ISO8601) (Maybe Text) DeploymentMode EngineType
- newBrokerSummary :: DeploymentMode -> EngineType -> BrokerSummary
- data Configuration = Configuration' (Maybe (HashMap Text Text)) Text Text ConfigurationRevision AuthenticationStrategy EngineType Text Text Text ISO8601
- newConfiguration :: Text -> Text -> ConfigurationRevision -> AuthenticationStrategy -> EngineType -> Text -> Text -> Text -> UTCTime -> Configuration
- data ConfigurationId = ConfigurationId' (Maybe Int) Text
- newConfigurationId :: Text -> ConfigurationId
- data ConfigurationRevision = ConfigurationRevision' (Maybe Text) Int ISO8601
- newConfigurationRevision :: Int -> UTCTime -> ConfigurationRevision
- data Configurations = Configurations' (Maybe ConfigurationId) (Maybe [ConfigurationId]) (Maybe ConfigurationId)
- newConfigurations :: Configurations
- data EncryptionOptions = EncryptionOptions' (Maybe Text) Bool
- newEncryptionOptions :: Bool -> EncryptionOptions
- data EngineVersion = EngineVersion' (Maybe Text)
- newEngineVersion :: EngineVersion
- data LdapServerMetadataInput = LdapServerMetadataInput' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) [Text] Text Text Text Text Text Text
- newLdapServerMetadataInput :: Text -> Text -> Text -> Text -> Text -> Text -> LdapServerMetadataInput
- data LdapServerMetadataOutput = LdapServerMetadataOutput' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) [Text] Text Text Text Text Text
- newLdapServerMetadataOutput :: Text -> Text -> Text -> Text -> Text -> LdapServerMetadataOutput
- data Logs = Logs' (Maybe Bool) (Maybe Bool)
- newLogs :: Logs
- data LogsSummary = LogsSummary' (Maybe Bool) (Maybe Text) (Maybe PendingLogs) Text Bool
- newLogsSummary :: Text -> Bool -> LogsSummary
- data PendingLogs = PendingLogs' (Maybe Bool) (Maybe Bool)
- newPendingLogs :: PendingLogs
- data SanitizationWarning = SanitizationWarning' (Maybe Text) (Maybe Text) SanitizationWarningReason
- newSanitizationWarning :: SanitizationWarningReason -> SanitizationWarning
- data User = User' (Maybe Bool) (Maybe [Text]) Text Text
- newUser :: Text -> Text -> User
- data UserPendingChanges = UserPendingChanges' (Maybe Bool) (Maybe [Text]) ChangeType
- newUserPendingChanges :: ChangeType -> UserPendingChanges
- data UserSummary = UserSummary' (Maybe ChangeType) Text
- newUserSummary :: Text -> UserSummary
- data WeeklyStartTime = WeeklyStartTime' (Maybe Text) Text DayOfWeek
- newWeeklyStartTime :: Text -> DayOfWeek -> WeeklyStartTime
Service Configuration
defaultService :: Service Source #
API version 2017-11-27 of the Amazon MQ SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MQ.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
ForbiddenException
_ForbiddenException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
InternalServerErrorException
_InternalServerErrorException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
UnauthorizedException
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateBroker
data CreateBroker Source #
Creates a broker using the specified properties.
See: newCreateBroker smart constructor.
Constructors
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Bool | |
| -> Text | |
| -> DeploymentMode | |
| -> EngineType | |
| -> Bool | |
| -> CreateBroker |
Create a value of CreateBroker 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:
CreateBroker, createBroker_authenticationStrategy - Optional. The authentication strategy used to secure the broker. The
default is SIMPLE.
$sel:configuration:CreateBroker', createBroker_configuration - A list of information about the configuration.
$sel:creatorRequestId:CreateBroker', createBroker_creatorRequestId - 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.
$sel:encryptionOptions:CreateBroker', createBroker_encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
$sel:ldapServerMetadata:CreateBroker', createBroker_ldapServerMetadata - Optional. The metadata of the LDAP server used to authenticate and
authorize connections to the broker. Does not apply to RabbitMQ brokers.
$sel:logs:CreateBroker', createBroker_logs - Enables Amazon CloudWatch logging for brokers.
$sel:maintenanceWindowStartTime:CreateBroker', createBroker_maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
$sel:securityGroups:CreateBroker', createBroker_securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to
brokers.
CreateBroker, createBroker_storageType - The broker's storage type.
$sel:subnetIds:CreateBroker', createBroker_subnetIds - The list of groups that define which subnets and IP ranges the broker
can use from different Availability Zones. If you specify more than one
subnet, the subnets must be in different Availability Zones. Amazon MQ
will not be able to create VPC endpoints for your broker with multiple
subnets in the same Availability Zone. A SINGLE_INSTANCE deployment
requires one subnet (for example, the default subnet). An
ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two
subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no
subnet requirements when deployed with public accessibility. Deployment
without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
CreateBroker, createBroker_tags - Create tags when creating the broker.
CreateBroker, createBroker_engineVersion - Required. The broker engine's version. For a list of supported engine
versions, see
Supported engines.
CreateBroker, createBroker_hostInstanceType - Required. The broker's instance type.
$sel:autoMinorVersionUpgrade:CreateBroker', createBroker_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. Set to true by default, if no value is specified.
$sel:users:CreateBroker', createBroker_users - Required. The list of broker 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.
Amazon MQ for RabbitMQ
When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
CreateBroker, createBroker_brokerName - Required. 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.
CreateBroker, createBroker_deploymentMode - Required. The broker's deployment mode.
CreateBroker, createBroker_engineType - Required. The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQ and RABBITMQ.
$sel:publiclyAccessible:CreateBroker', createBroker_publiclyAccessible - Enables connections from applications outside of the VPC that hosts the
broker's subnets. Set to false by default, if no value is provided.
data CreateBrokerResponse Source #
See: newCreateBrokerResponse smart constructor.
Instances
newCreateBrokerResponse Source #
Arguments
| :: Int | |
| -> CreateBrokerResponse |
Create a value of CreateBrokerResponse 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:
CreateBrokerResponse, createBrokerResponse_brokerArn - The broker's Amazon Resource Name (ARN).
CreateBrokerResponse, createBrokerResponse_brokerId - The unique ID that Amazon MQ generates for the broker.
$sel:httpStatus:CreateBrokerResponse', createBrokerResponse_httpStatus - The response's http status code.
CreateConfiguration
data CreateConfiguration Source #
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
See: newCreateConfiguration smart constructor.
Constructors
| CreateConfiguration' (Maybe AuthenticationStrategy) (Maybe (HashMap Text Text)) Text EngineType Text |
Instances
newCreateConfiguration Source #
Arguments
| :: Text | |
| -> EngineType | |
| -> Text | |
| -> CreateConfiguration |
Create a value of CreateConfiguration 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:
CreateConfiguration, createConfiguration_authenticationStrategy - Optional. The authentication strategy associated with the configuration.
The default is SIMPLE.
CreateConfiguration, createConfiguration_tags - Create tags when creating the configuration.
CreateConfiguration, createConfiguration_engineVersion - Required. The broker engine's version. For a list of supported engine
versions, see
Supported engines.
CreateConfiguration, createConfiguration_engineType - Required. The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQ and RABBITMQ.
CreateConfiguration, createConfiguration_name - Required. The name of the configuration. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 1-150 characters long.
data CreateConfigurationResponse Source #
See: newCreateConfigurationResponse smart constructor.
Constructors
| CreateConfigurationResponse' (Maybe Text) (Maybe AuthenticationStrategy) (Maybe ISO8601) (Maybe Text) (Maybe ConfigurationRevision) (Maybe Text) Int |
Instances
newCreateConfigurationResponse Source #
Create a value of CreateConfigurationResponse 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:
CreateConfigurationResponse, createConfigurationResponse_arn - Required. The Amazon Resource Name (ARN) of the configuration.
CreateConfiguration, createConfigurationResponse_authenticationStrategy - Optional. The authentication strategy associated with the configuration.
The default is SIMPLE.
CreateConfigurationResponse, createConfigurationResponse_created - Required. The date and time of the configuration.
CreateConfigurationResponse, createConfigurationResponse_id - Required. The unique ID that Amazon MQ generates for the configuration.
CreateConfigurationResponse, createConfigurationResponse_latestRevision - The latest revision of the configuration.
CreateConfiguration, createConfigurationResponse_name - Required. The name of the configuration. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 1-150 characters long.
$sel:httpStatus:CreateConfigurationResponse', createConfigurationResponse_httpStatus - The response's http status code.
CreateTags
data CreateTags Source #
A map of the key-value pairs for the resource tag.
See: newCreateTags smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateTags |
Create a value of CreateTags 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:
CreateTags, createTags_tags - The key-value pair for the resource tag.
$sel:resourceArn:CreateTags', createTags_resourceArn - The Amazon Resource Name (ARN) of the resource tag.
data CreateTagsResponse Source #
See: newCreateTagsResponse smart constructor.
Constructors
| CreateTagsResponse' | |
Instances
| Generic CreateTagsResponse Source # | |
Defined in Amazonka.MQ.CreateTags Associated Types type Rep CreateTagsResponse :: Type -> Type # Methods from :: CreateTagsResponse -> Rep CreateTagsResponse x # to :: Rep CreateTagsResponse x -> CreateTagsResponse # | |
| Read CreateTagsResponse Source # | |
Defined in Amazonka.MQ.CreateTags Methods readsPrec :: Int -> ReadS CreateTagsResponse # readList :: ReadS [CreateTagsResponse] # | |
| Show CreateTagsResponse Source # | |
Defined in Amazonka.MQ.CreateTags Methods showsPrec :: Int -> CreateTagsResponse -> ShowS # show :: CreateTagsResponse -> String # showList :: [CreateTagsResponse] -> ShowS # | |
| NFData CreateTagsResponse Source # | |
Defined in Amazonka.MQ.CreateTags Methods rnf :: CreateTagsResponse -> () # | |
| Eq CreateTagsResponse Source # | |
Defined in Amazonka.MQ.CreateTags Methods (==) :: CreateTagsResponse -> CreateTagsResponse -> Bool # (/=) :: CreateTagsResponse -> CreateTagsResponse -> Bool # | |
| type Rep CreateTagsResponse Source # | |
newCreateTagsResponse :: CreateTagsResponse Source #
Create a value of CreateTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateUser
data CreateUser Source #
Creates a new ActiveMQ user.
See: newCreateUser smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateUser |
Create a value of CreateUser 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:
CreateUser, createUser_consoleAccess - Enables access to the ActiveMQ Web Console for the ActiveMQ user.
CreateUser, createUser_groups - The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters
long.
CreateUser, createUser_username - The username of the ActiveMQ user. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 2-100 characters long.
CreateUser, createUser_brokerId - The unique ID that Amazon MQ generates for the broker.
CreateUser, createUser_password - Required. The password of the user. This value must be at least 12
characters long, must contain at least 4 unique characters, and must not
contain commas, colons, or equal signs (,:=).
data CreateUserResponse Source #
See: newCreateUserResponse smart constructor.
Constructors
| CreateUserResponse' Int |
Instances
newCreateUserResponse Source #
Arguments
| :: Int | |
| -> CreateUserResponse |
Create a value of CreateUserResponse 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:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.
DeleteBroker
data DeleteBroker Source #
See: newDeleteBroker smart constructor.
Constructors
| DeleteBroker' Text |
Instances
Arguments
| :: Text | |
| -> DeleteBroker |
Create a value of DeleteBroker 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:
DeleteBroker, deleteBroker_brokerId - The unique ID that Amazon MQ generates for the broker.
data DeleteBrokerResponse Source #
See: newDeleteBrokerResponse smart constructor.
Constructors
| DeleteBrokerResponse' (Maybe Text) Int |
Instances
newDeleteBrokerResponse Source #
Arguments
| :: Int | |
| -> DeleteBrokerResponse |
Create a value of DeleteBrokerResponse 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:
DeleteBroker, deleteBrokerResponse_brokerId - The unique ID that Amazon MQ generates for the broker.
$sel:httpStatus:DeleteBrokerResponse', deleteBrokerResponse_httpStatus - The response's http status code.
DeleteTags
data DeleteTags Source #
See: newDeleteTags smart constructor.
Constructors
| DeleteTags' [Text] Text |
Instances
Arguments
| :: Text | |
| -> DeleteTags |
Create a value of DeleteTags 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:tagKeys:DeleteTags', deleteTags_tagKeys - An array of tag keys to delete
$sel:resourceArn:DeleteTags', deleteTags_resourceArn - The Amazon Resource Name (ARN) of the resource tag.
data DeleteTagsResponse Source #
See: newDeleteTagsResponse smart constructor.
Constructors
| DeleteTagsResponse' | |
Instances
| Generic DeleteTagsResponse Source # | |
Defined in Amazonka.MQ.DeleteTags Associated Types type Rep DeleteTagsResponse :: Type -> Type # Methods from :: DeleteTagsResponse -> Rep DeleteTagsResponse x # to :: Rep DeleteTagsResponse x -> DeleteTagsResponse # | |
| Read DeleteTagsResponse Source # | |
Defined in Amazonka.MQ.DeleteTags Methods readsPrec :: Int -> ReadS DeleteTagsResponse # readList :: ReadS [DeleteTagsResponse] # | |
| Show DeleteTagsResponse Source # | |
Defined in Amazonka.MQ.DeleteTags Methods showsPrec :: Int -> DeleteTagsResponse -> ShowS # show :: DeleteTagsResponse -> String # showList :: [DeleteTagsResponse] -> ShowS # | |
| NFData DeleteTagsResponse Source # | |
Defined in Amazonka.MQ.DeleteTags Methods rnf :: DeleteTagsResponse -> () # | |
| Eq DeleteTagsResponse Source # | |
Defined in Amazonka.MQ.DeleteTags Methods (==) :: DeleteTagsResponse -> DeleteTagsResponse -> Bool # (/=) :: DeleteTagsResponse -> DeleteTagsResponse -> Bool # | |
| type Rep DeleteTagsResponse Source # | |
newDeleteTagsResponse :: DeleteTagsResponse Source #
Create a value of DeleteTagsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteUser
data DeleteUser Source #
See: newDeleteUser smart constructor.
Constructors
| DeleteUser' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteUser |
Create a value of DeleteUser 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:
DeleteUser, deleteUser_username - The username of the ActiveMQ user. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 2-100 characters long.
DeleteUser, deleteUser_brokerId - The unique ID that Amazon MQ generates for the broker.
data DeleteUserResponse Source #
See: newDeleteUserResponse smart constructor.
Constructors
| DeleteUserResponse' Int |
Instances
newDeleteUserResponse Source #
Arguments
| :: Int | |
| -> DeleteUserResponse |
Create a value of DeleteUserResponse 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:httpStatus:DeleteUserResponse', deleteUserResponse_httpStatus - The response's http status code.
DescribeBroker
data DescribeBroker Source #
See: newDescribeBroker smart constructor.
Constructors
| DescribeBroker' Text |
Instances
Arguments
| :: Text | |
| -> DescribeBroker |
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:
DescribeBroker, describeBroker_brokerId - The unique ID that Amazon MQ generates for the broker.
data DescribeBrokerResponse Source #
See: newDescribeBrokerResponse smart constructor.
Constructors
| DescribeBrokerResponse' (Maybe [ActionRequired]) (Maybe AuthenticationStrategy) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [BrokerInstance]) (Maybe Text) (Maybe BrokerState) (Maybe Configurations) (Maybe ISO8601) (Maybe DeploymentMode) (Maybe EncryptionOptions) (Maybe EngineType) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataOutput) (Maybe LogsSummary) (Maybe WeeklyStartTime) (Maybe AuthenticationStrategy) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataOutput) (Maybe [Text]) (Maybe Bool) (Maybe [Text]) (Maybe BrokerStorageType) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe [UserSummary]) Int |
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:actionsRequired:DescribeBrokerResponse', describeBrokerResponse_actionsRequired - A list of actions required for a broker.
DescribeBrokerResponse, describeBrokerResponse_authenticationStrategy - The authentication strategy used to secure the broker. The default is
SIMPLE.
$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.
DescribeBrokerResponse, describeBrokerResponse_brokerArn - The broker's Amazon Resource Name (ARN).
DescribeBroker, describeBrokerResponse_brokerId - The unique ID that Amazon MQ generates for the broker.
$sel:brokerInstances:DescribeBrokerResponse', describeBrokerResponse_brokerInstances - A list of information about allocated brokers.
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.
DescribeBrokerResponse, describeBrokerResponse_brokerState - The broker's status.
$sel:configurations:DescribeBrokerResponse', describeBrokerResponse_configurations - The list of all revisions for the specified configuration.
DescribeBrokerResponse, describeBrokerResponse_created - The time when the broker was created.
DescribeBrokerResponse, describeBrokerResponse_deploymentMode - The broker's deployment mode.
$sel:encryptionOptions:DescribeBrokerResponse', describeBrokerResponse_encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.
DescribeBrokerResponse, describeBrokerResponse_engineType - The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and
RABBITMQ.
DescribeBrokerResponse, describeBrokerResponse_engineVersion - The broker engine's version. For a list of supported engine versions,
see
Supported engines.
DescribeBrokerResponse, describeBrokerResponse_hostInstanceType - The broker's instance type.
$sel:ldapServerMetadata:DescribeBrokerResponse', describeBrokerResponse_ldapServerMetadata - The metadata of the LDAP server used to authenticate and authorize
connections to the broker.
$sel:logs:DescribeBrokerResponse', describeBrokerResponse_logs - The list of information about logs currently enabled and pending to be
deployed for the specified broker.
$sel:maintenanceWindowStartTime:DescribeBrokerResponse', describeBrokerResponse_maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
$sel:pendingAuthenticationStrategy:DescribeBrokerResponse', describeBrokerResponse_pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is
rebooted. The default is SIMPLE.
$sel:pendingEngineVersion:DescribeBrokerResponse', describeBrokerResponse_pendingEngineVersion - The broker engine version to upgrade to. For a list of supported engine
versions, see
Supported engines.
$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: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:pendingSecurityGroups:DescribeBrokerResponse', describeBrokerResponse_pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.
$sel:publiclyAccessible:DescribeBrokerResponse', describeBrokerResponse_publiclyAccessible - Enables connections from applications outside of the VPC that hosts the
broker's subnets.
$sel:securityGroups:DescribeBrokerResponse', describeBrokerResponse_securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to
brokers.
DescribeBrokerResponse, describeBrokerResponse_storageType - The broker's storage type.
$sel:subnetIds:DescribeBrokerResponse', describeBrokerResponse_subnetIds - The list of groups that define which subnets and IP ranges the broker
can use from different Availability Zones.
DescribeBrokerResponse, describeBrokerResponse_tags - The list of all tags associated with this broker.
$sel:users:DescribeBrokerResponse', describeBrokerResponse_users - The list of all broker usernames for the specified broker.
$sel:httpStatus:DescribeBrokerResponse', describeBrokerResponse_httpStatus - The response's http status code.
DescribeBrokerEngineTypes
data DescribeBrokerEngineTypes Source #
See: newDescribeBrokerEngineTypes smart constructor.
Instances
newDescribeBrokerEngineTypes :: DescribeBrokerEngineTypes Source #
Create a value of DescribeBrokerEngineTypes 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:
DescribeBrokerEngineTypes, describeBrokerEngineTypes_engineType - Filter response by engine type.
DescribeBrokerEngineTypes, describeBrokerEngineTypes_maxResults - The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
DescribeBrokerEngineTypes, describeBrokerEngineTypes_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
data DescribeBrokerEngineTypesResponse Source #
See: newDescribeBrokerEngineTypesResponse smart constructor.
Constructors
| DescribeBrokerEngineTypesResponse' (Maybe [BrokerEngineType]) (Maybe Natural) (Maybe Text) Int |
Instances
newDescribeBrokerEngineTypesResponse Source #
Arguments
| :: Int | |
| -> DescribeBrokerEngineTypesResponse |
Create a value of DescribeBrokerEngineTypesResponse 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:brokerEngineTypes:DescribeBrokerEngineTypesResponse', describeBrokerEngineTypesResponse_brokerEngineTypes - List of available engine types and versions.
DescribeBrokerEngineTypes, describeBrokerEngineTypesResponse_maxResults - Required. The maximum number of engine types that can be returned per
page (20 by default). This value must be an integer from 5 to 100.
DescribeBrokerEngineTypes, describeBrokerEngineTypesResponse_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
$sel:httpStatus:DescribeBrokerEngineTypesResponse', describeBrokerEngineTypesResponse_httpStatus - The response's http status code.
DescribeBrokerInstanceOptions
data DescribeBrokerInstanceOptions Source #
See: newDescribeBrokerInstanceOptions smart constructor.
Constructors
| DescribeBrokerInstanceOptions' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) |
Instances
newDescribeBrokerInstanceOptions :: DescribeBrokerInstanceOptions Source #
Create a value of DescribeBrokerInstanceOptions 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:
DescribeBrokerInstanceOptions, describeBrokerInstanceOptions_engineType - Filter response by engine type.
DescribeBrokerInstanceOptions, describeBrokerInstanceOptions_hostInstanceType - Filter response by host instance type.
DescribeBrokerInstanceOptions, describeBrokerInstanceOptions_maxResults - The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
DescribeBrokerInstanceOptions, describeBrokerInstanceOptions_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
DescribeBrokerInstanceOptions, describeBrokerInstanceOptions_storageType - Filter response by storage type.
data DescribeBrokerInstanceOptionsResponse Source #
See: newDescribeBrokerInstanceOptionsResponse smart constructor.
Constructors
| DescribeBrokerInstanceOptionsResponse' (Maybe [BrokerInstanceOption]) (Maybe Natural) (Maybe Text) Int |
Instances
newDescribeBrokerInstanceOptionsResponse Source #
Arguments
| :: Int | |
| -> DescribeBrokerInstanceOptionsResponse |
Create a value of DescribeBrokerInstanceOptionsResponse 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:brokerInstanceOptions:DescribeBrokerInstanceOptionsResponse', describeBrokerInstanceOptionsResponse_brokerInstanceOptions - List of available broker instance options.
DescribeBrokerInstanceOptions, describeBrokerInstanceOptionsResponse_maxResults - Required. The maximum number of instance options that can be returned
per page (20 by default). This value must be an integer from 5 to 100.
DescribeBrokerInstanceOptions, describeBrokerInstanceOptionsResponse_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
$sel:httpStatus:DescribeBrokerInstanceOptionsResponse', describeBrokerInstanceOptionsResponse_httpStatus - The response's http status code.
DescribeConfiguration
data DescribeConfiguration Source #
See: newDescribeConfiguration smart constructor.
Constructors
| DescribeConfiguration' Text |
Instances
newDescribeConfiguration Source #
Create a value of DescribeConfiguration 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:configurationId:DescribeConfiguration', describeConfiguration_configurationId - The unique ID that Amazon MQ generates for the configuration.
data DescribeConfigurationResponse Source #
See: newDescribeConfigurationResponse smart constructor.
Constructors
| DescribeConfigurationResponse' (Maybe Text) (Maybe AuthenticationStrategy) (Maybe ISO8601) (Maybe Text) (Maybe EngineType) (Maybe Text) (Maybe Text) (Maybe ConfigurationRevision) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeConfigurationResponse Source #
Create a value of DescribeConfigurationResponse 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:
DescribeConfigurationResponse, describeConfigurationResponse_arn - Required. The ARN of the configuration.
DescribeConfigurationResponse, describeConfigurationResponse_authenticationStrategy - Optional. The authentication strategy associated with the configuration.
The default is SIMPLE.
DescribeConfigurationResponse, describeConfigurationResponse_created - Required. The date and time of the configuration revision.
DescribeConfigurationResponse, describeConfigurationResponse_description - Required. The description of the configuration.
DescribeConfigurationResponse, describeConfigurationResponse_engineType - Required. The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQ and RABBITMQ.
DescribeConfigurationResponse, describeConfigurationResponse_engineVersion - Required. The broker engine's version. For a list of supported engine
versions, see,
Supported engines.
DescribeConfigurationResponse, describeConfigurationResponse_id - Required. The unique ID that Amazon MQ generates for the configuration.
DescribeConfigurationResponse, describeConfigurationResponse_latestRevision - Required. The latest revision of the configuration.
DescribeConfigurationResponse, describeConfigurationResponse_name - Required. The name of the configuration. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 1-150 characters long.
DescribeConfigurationResponse, describeConfigurationResponse_tags - The list of all tags associated with this configuration.
$sel:httpStatus:DescribeConfigurationResponse', describeConfigurationResponse_httpStatus - The response's http status code.
DescribeConfigurationRevision
data DescribeConfigurationRevision Source #
See: newDescribeConfigurationRevision smart constructor.
Constructors
| DescribeConfigurationRevision' Text Text |
Instances
newDescribeConfigurationRevision Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeConfigurationRevision |
Create a value of DescribeConfigurationRevision 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:configurationRevision:DescribeConfigurationRevision', describeConfigurationRevision_configurationRevision - The revision of the configuration.
DescribeConfigurationRevision, describeConfigurationRevision_configurationId - The unique ID that Amazon MQ generates for the configuration.
data DescribeConfigurationRevisionResponse Source #
See: newDescribeConfigurationRevisionResponse smart constructor.
Constructors
| DescribeConfigurationRevisionResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeConfigurationRevisionResponse Source #
Arguments
| :: Int | |
| -> DescribeConfigurationRevisionResponse |
Create a value of DescribeConfigurationRevisionResponse 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:
DescribeConfigurationRevision, describeConfigurationRevisionResponse_configurationId - Required. The unique ID that Amazon MQ generates for the configuration.
DescribeConfigurationRevisionResponse, describeConfigurationRevisionResponse_created - Required. The date and time of the configuration.
$sel:data':DescribeConfigurationRevisionResponse', describeConfigurationRevisionResponse_data - Required. The base64-encoded XML configuration.
DescribeConfigurationRevisionResponse, describeConfigurationRevisionResponse_description - The description of the configuration.
$sel:httpStatus:DescribeConfigurationRevisionResponse', describeConfigurationRevisionResponse_httpStatus - The response's http status code.
DescribeUser
data DescribeUser Source #
See: newDescribeUser smart constructor.
Constructors
| DescribeUser' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeUser |
Create a value of DescribeUser 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:
DescribeUser, describeUser_username - The username of the ActiveMQ user. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 2-100 characters long.
DescribeUser, describeUser_brokerId - The unique ID that Amazon MQ generates for the broker.
data DescribeUserResponse Source #
See: newDescribeUserResponse smart constructor.
Constructors
| DescribeUserResponse' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe UserPendingChanges) (Maybe Text) Int |
Instances
newDescribeUserResponse Source #
Arguments
| :: Int | |
| -> DescribeUserResponse |
Create a value of DescribeUserResponse 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:
DescribeUser, describeUserResponse_brokerId - Required. The unique ID that Amazon MQ generates for the broker.
DescribeUserResponse, describeUserResponse_consoleAccess - Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
DescribeUserResponse, describeUserResponse_groups - The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters
long.
DescribeUserResponse, describeUserResponse_pending - The status of the changes pending for the ActiveMQ user.
DescribeUser, describeUserResponse_username - Required. The username of the ActiveMQ user. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 2-100 characters long.
$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.
ListBrokers (Paginated)
data ListBrokers Source #
See: newListBrokers smart constructor.
Constructors
| ListBrokers' (Maybe Natural) (Maybe Text) |
Instances
newListBrokers :: ListBrokers Source #
Create a value of ListBrokers 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:maxResults:ListBrokers', listBrokers_maxResults - The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
ListBrokers, listBrokers_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
data ListBrokersResponse Source #
See: newListBrokersResponse smart constructor.
Constructors
| ListBrokersResponse' (Maybe [BrokerSummary]) (Maybe Text) Int |
Instances
newListBrokersResponse Source #
Arguments
| :: Int | |
| -> ListBrokersResponse |
Create a value of ListBrokersResponse 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:brokerSummaries:ListBrokersResponse', listBrokersResponse_brokerSummaries - A list of information about all brokers.
ListBrokers, listBrokersResponse_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
$sel:httpStatus:ListBrokersResponse', listBrokersResponse_httpStatus - The response's http status code.
ListConfigurationRevisions
data ListConfigurationRevisions Source #
See: newListConfigurationRevisions smart constructor.
Instances
newListConfigurationRevisions Source #
Arguments
| :: Text | |
| -> ListConfigurationRevisions |
Create a value of ListConfigurationRevisions 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:
ListConfigurationRevisions, listConfigurationRevisions_maxResults - The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
ListConfigurationRevisions, listConfigurationRevisions_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
ListConfigurationRevisions, listConfigurationRevisions_configurationId - The unique ID that Amazon MQ generates for the configuration.
data ListConfigurationRevisionsResponse Source #
See: newListConfigurationRevisionsResponse smart constructor.
Constructors
| ListConfigurationRevisionsResponse' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [ConfigurationRevision]) Int |
Instances
newListConfigurationRevisionsResponse Source #
Arguments
| :: Int | |
| -> ListConfigurationRevisionsResponse |
Create a value of ListConfigurationRevisionsResponse 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:
ListConfigurationRevisions, listConfigurationRevisionsResponse_configurationId - The unique ID that Amazon MQ generates for the configuration.
ListConfigurationRevisions, listConfigurationRevisionsResponse_maxResults - The maximum number of configuration revisions that can be returned per
page (20 by default). This value must be an integer from 5 to 100.
ListConfigurationRevisions, listConfigurationRevisionsResponse_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
$sel:revisions:ListConfigurationRevisionsResponse', listConfigurationRevisionsResponse_revisions - The list of all revisions for the specified configuration.
$sel:httpStatus:ListConfigurationRevisionsResponse', listConfigurationRevisionsResponse_httpStatus - The response's http status code.
ListConfigurations
data ListConfigurations Source #
See: newListConfigurations smart constructor.
Constructors
| ListConfigurations' (Maybe Natural) (Maybe Text) |
Instances
newListConfigurations :: ListConfigurations Source #
Create a value of ListConfigurations 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:
ListConfigurations, listConfigurations_maxResults - The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
ListConfigurations, listConfigurations_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
data ListConfigurationsResponse Source #
See: newListConfigurationsResponse smart constructor.
Constructors
| ListConfigurationsResponse' (Maybe [Configuration]) (Maybe Int) (Maybe Text) Int |
Instances
newListConfigurationsResponse Source #
Create a value of ListConfigurationsResponse 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:configurations:ListConfigurationsResponse', listConfigurationsResponse_configurations - The list of all revisions for the specified configuration.
ListConfigurations, listConfigurationsResponse_maxResults - The maximum number of configurations that Amazon MQ can return per page
(20 by default). This value must be an integer from 5 to 100.
ListConfigurations, listConfigurationsResponse_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
$sel:httpStatus:ListConfigurationsResponse', listConfigurationsResponse_httpStatus - The response's http status code.
ListTags
See: newListTags smart constructor.
Instances
| ToHeaders ListTags Source # | |
Defined in Amazonka.MQ.ListTags | |
| ToPath ListTags Source # | |
Defined in Amazonka.MQ.ListTags Methods toPath :: ListTags -> ByteString # | |
| ToQuery ListTags Source # | |
Defined in Amazonka.MQ.ListTags Methods toQuery :: ListTags -> QueryString # | |
| AWSRequest ListTags Source # | |
Defined in Amazonka.MQ.ListTags Associated Types type AWSResponse ListTags # Methods request :: (Service -> Service) -> ListTags -> Request ListTags # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTags))) # | |
| Generic ListTags Source # | |
| Read ListTags Source # | |
| Show ListTags Source # | |
| NFData ListTags Source # | |
Defined in Amazonka.MQ.ListTags | |
| Eq ListTags Source # | |
| Hashable ListTags Source # | |
Defined in Amazonka.MQ.ListTags | |
| type AWSResponse ListTags Source # | |
Defined in Amazonka.MQ.ListTags | |
| type Rep ListTags Source # | |
Defined in Amazonka.MQ.ListTags | |
Create a value of ListTags 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:resourceArn:ListTags', listTags_resourceArn - The Amazon Resource Name (ARN) of the resource tag.
data ListTagsResponse Source #
See: newListTagsResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListTagsResponse |
Create a value of ListTagsResponse 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:
ListTagsResponse, listTagsResponse_tags - The key-value pair for the resource tag.
$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.
ListUsers
See: newListUsers smart constructor.
Instances
Create a value of ListUsers 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:
ListUsers, listUsers_maxResults - The maximum number of brokers that Amazon MQ can return per page (20 by
default). This value must be an integer from 5 to 100.
ListUsers, listUsers_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
ListUsers, listUsers_brokerId - The unique ID that Amazon MQ generates for the broker.
data ListUsersResponse Source #
See: newListUsersResponse smart constructor.
Constructors
| ListUsersResponse' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe [UserSummary]) Int |
Instances
Arguments
| :: Int | |
| -> ListUsersResponse |
Create a value of ListUsersResponse 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:
ListUsers, listUsersResponse_brokerId - Required. The unique ID that Amazon MQ generates for the broker.
ListUsers, listUsersResponse_maxResults - Required. The maximum number of ActiveMQ users that can be returned per
page (20 by default). This value must be an integer from 5 to 100.
ListUsers, listUsersResponse_nextToken - The token that specifies the next page of results Amazon MQ should
return. To request the first page, leave nextToken empty.
$sel:users:ListUsersResponse', listUsersResponse_users - Required. The list of all ActiveMQ usernames for the specified broker.
Does not apply to RabbitMQ brokers.
$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.
RebootBroker
data RebootBroker Source #
See: newRebootBroker smart constructor.
Constructors
| RebootBroker' Text |
Instances
Arguments
| :: Text | |
| -> RebootBroker |
Create a value of RebootBroker 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:
RebootBroker, rebootBroker_brokerId - The unique ID that Amazon MQ generates for the broker.
data RebootBrokerResponse Source #
See: newRebootBrokerResponse smart constructor.
Constructors
| RebootBrokerResponse' Int |
Instances
newRebootBrokerResponse Source #
Arguments
| :: Int | |
| -> RebootBrokerResponse |
Create a value of RebootBrokerResponse 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:httpStatus:RebootBrokerResponse', rebootBrokerResponse_httpStatus - The response's http status code.
UpdateBroker
data UpdateBroker Source #
Updates the broker using the specified properties.
See: newUpdateBroker smart constructor.
Constructors
| UpdateBroker' (Maybe AuthenticationStrategy) (Maybe Bool) (Maybe ConfigurationId) (Maybe Text) (Maybe Text) (Maybe LdapServerMetadataInput) (Maybe Logs) (Maybe WeeklyStartTime) (Maybe [Text]) Text |
Instances
Arguments
| :: Text | |
| -> UpdateBroker |
Create a value of UpdateBroker 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:
UpdateBroker, updateBroker_authenticationStrategy - Optional. The authentication strategy used to secure the broker. The
default is SIMPLE.
UpdateBroker, updateBroker_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.
UpdateBroker, updateBroker_configuration - A list of information about the configuration.
UpdateBroker, updateBroker_engineVersion - The broker engine version. For a list of supported engine versions, see
Supported engines.
UpdateBroker, updateBroker_hostInstanceType - The broker's host instance type to upgrade to. For a list of supported
instance types, see
Broker instance types.
UpdateBroker, updateBroker_ldapServerMetadata - Optional. The metadata of the LDAP server used to authenticate and
authorize connections to the broker. Does not apply to RabbitMQ brokers.
UpdateBroker, updateBroker_logs - Enables Amazon CloudWatch logging for brokers.
UpdateBroker, updateBroker_maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
UpdateBroker, updateBroker_securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes
connections to brokers.
UpdateBroker, updateBroker_brokerId - The unique ID that Amazon MQ generates for the broker.
data UpdateBrokerResponse Source #
See: newUpdateBrokerResponse smart constructor.
Constructors
Instances
newUpdateBrokerResponse Source #
Arguments
| :: Int | |
| -> UpdateBrokerResponse |
Create a value of UpdateBrokerResponse 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:
UpdateBroker, updateBrokerResponse_authenticationStrategy - Optional. The authentication strategy used to secure the broker. The
default is SIMPLE.
UpdateBroker, updateBrokerResponse_autoMinorVersionUpgrade - The new boolean value that specifies whether broker engines
automatically upgrade to new minor versions as new versions are released
and supported by Amazon MQ.
UpdateBroker, updateBrokerResponse_brokerId - Required. The unique ID that Amazon MQ generates for the broker.
UpdateBroker, updateBrokerResponse_configuration - The ID of the updated configuration.
UpdateBroker, updateBrokerResponse_engineVersion - The broker engine version to upgrade to. For a list of supported engine
versions, see
Supported engines.
UpdateBroker, updateBrokerResponse_hostInstanceType - The broker's host instance type to upgrade to. For a list of supported
instance types, see
Broker instance types.
UpdateBroker, updateBrokerResponse_ldapServerMetadata - Optional. The metadata of the LDAP server used to authenticate and
authorize connections to the broker. Does not apply to RabbitMQ brokers.
UpdateBroker, updateBrokerResponse_logs - The list of information about logs to be enabled for the specified
broker.
UpdateBroker, updateBrokerResponse_maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.
UpdateBroker, updateBrokerResponse_securityGroups - The list of security groups (1 minimum, 5 maximum) that authorizes
connections to brokers.
$sel:httpStatus:UpdateBrokerResponse', updateBrokerResponse_httpStatus - The response's http status code.
UpdateConfiguration
data UpdateConfiguration Source #
Updates the specified configuration.
See: newUpdateConfiguration smart constructor.
Constructors
| UpdateConfiguration' (Maybe Text) Text Text |
Instances
newUpdateConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateConfiguration |
Create a value of UpdateConfiguration 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:
UpdateConfiguration, updateConfiguration_description - The description of the configuration.
$sel:configurationId:UpdateConfiguration', updateConfiguration_configurationId - The unique ID that Amazon MQ generates for the configuration.
$sel:data':UpdateConfiguration', updateConfiguration_data - Required. The base64-encoded XML configuration.
data UpdateConfigurationResponse Source #
See: newUpdateConfigurationResponse smart constructor.
Constructors
| UpdateConfigurationResponse' (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe ConfigurationRevision) (Maybe Text) (Maybe [SanitizationWarning]) Int |
Instances
newUpdateConfigurationResponse Source #
Create a value of UpdateConfigurationResponse 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:
UpdateConfigurationResponse, updateConfigurationResponse_arn - Required. The Amazon Resource Name (ARN) of the configuration.
UpdateConfigurationResponse, updateConfigurationResponse_created - Required. The date and time of the configuration.
UpdateConfigurationResponse, updateConfigurationResponse_id - Required. The unique ID that Amazon MQ generates for the configuration.
UpdateConfigurationResponse, updateConfigurationResponse_latestRevision - The latest revision of the configuration.
UpdateConfigurationResponse, updateConfigurationResponse_name - Required. The name of the configuration. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 1-150 characters long.
$sel:warnings:UpdateConfigurationResponse', updateConfigurationResponse_warnings - The list of the first 20 warnings about the configuration XML elements
or attributes that were sanitized.
$sel:httpStatus:UpdateConfigurationResponse', updateConfigurationResponse_httpStatus - The response's http status code.
UpdateUser
data UpdateUser Source #
Updates the information for an ActiveMQ user.
See: newUpdateUser smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateUser |
Create a value of UpdateUser 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:
UpdateUser, updateUser_consoleAccess - Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
UpdateUser, updateUser_groups - The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters
long.
UpdateUser, updateUser_password - The password of the user. This value must be at least 12 characters
long, must contain at least 4 unique characters, and must not contain
commas, colons, or equal signs (,:=).
UpdateUser, updateUser_username - The username of the ActiveMQ user. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 2-100 characters long.
UpdateUser, updateUser_brokerId - The unique ID that Amazon MQ generates for the broker.
data UpdateUserResponse Source #
See: newUpdateUserResponse smart constructor.
Constructors
| UpdateUserResponse' Int |
Instances
newUpdateUserResponse Source #
Arguments
| :: Int | |
| -> UpdateUserResponse |
Create a value of UpdateUserResponse 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:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.
Types
AuthenticationStrategy
newtype AuthenticationStrategy Source #
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
Constructors
| AuthenticationStrategy' | |
Fields | |
Bundled Patterns
| pattern AuthenticationStrategy_LDAP :: AuthenticationStrategy | |
| pattern AuthenticationStrategy_SIMPLE :: AuthenticationStrategy |
Instances
BrokerState
newtype BrokerState Source #
The broker's status.
Constructors
| BrokerState' | |
Fields | |
Bundled Patterns
| pattern BrokerState_CREATION_FAILED :: BrokerState | |
| pattern BrokerState_CREATION_IN_PROGRESS :: BrokerState | |
| pattern BrokerState_CRITICAL_ACTION_REQUIRED :: BrokerState | |
| pattern BrokerState_DELETION_IN_PROGRESS :: BrokerState | |
| pattern BrokerState_REBOOT_IN_PROGRESS :: BrokerState | |
| pattern BrokerState_RUNNING :: BrokerState |
Instances
BrokerStorageType
newtype BrokerStorageType Source #
The broker's storage type.
EFS is not supported for RabbitMQ engine type.
Constructors
| BrokerStorageType' | |
Fields | |
Bundled Patterns
| pattern BrokerStorageType_EBS :: BrokerStorageType | |
| pattern BrokerStorageType_EFS :: BrokerStorageType |
Instances
ChangeType
newtype ChangeType Source #
The type of change pending for the ActiveMQ user.
Constructors
| ChangeType' | |
Fields | |
Bundled Patterns
| pattern ChangeType_CREATE :: ChangeType | |
| pattern ChangeType_DELETE :: ChangeType | |
| pattern ChangeType_UPDATE :: ChangeType |
Instances
DayOfWeek
Constructors
| DayOfWeek' | |
Fields | |
Bundled Patterns
| pattern DayOfWeek_FRIDAY :: DayOfWeek | |
| pattern DayOfWeek_MONDAY :: DayOfWeek | |
| pattern DayOfWeek_SATURDAY :: DayOfWeek | |
| pattern DayOfWeek_SUNDAY :: DayOfWeek | |
| pattern DayOfWeek_THURSDAY :: DayOfWeek | |
| pattern DayOfWeek_TUESDAY :: DayOfWeek | |
| pattern DayOfWeek_WEDNESDAY :: DayOfWeek |
Instances
DeploymentMode
newtype DeploymentMode Source #
The broker's deployment mode.
Constructors
| DeploymentMode' | |
Fields | |
Bundled Patterns
| pattern DeploymentMode_ACTIVE_STANDBY_MULTI_AZ :: DeploymentMode | |
| pattern DeploymentMode_CLUSTER_MULTI_AZ :: DeploymentMode | |
| pattern DeploymentMode_SINGLE_INSTANCE :: DeploymentMode |
Instances
EngineType
newtype EngineType Source #
The type of broker engine. Amazon MQ supports ActiveMQ and RabbitMQ.
Constructors
| EngineType' | |
Fields | |
Bundled Patterns
| pattern EngineType_ACTIVEMQ :: EngineType | |
| pattern EngineType_RABBITMQ :: EngineType |
Instances
SanitizationWarningReason
newtype SanitizationWarningReason Source #
The reason for which the XML elements or attributes were sanitized.
Constructors
| SanitizationWarningReason' | |
Fields | |
Bundled Patterns
Instances
ActionRequired
data ActionRequired Source #
The action required to resolve a broker issue when the broker is in a CRITICAL_ACTION_REQUIRED state.
See: newActionRequired smart constructor.
Constructors
| ActionRequired' (Maybe Text) (Maybe Text) |
Instances
newActionRequired :: ActionRequired Source #
Create a value of ActionRequired 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:actionRequiredCode:ActionRequired', actionRequired_actionRequiredCode - The code you can use to resolve your broker issue when the broker is in
a CRITICAL_ACTION_REQUIRED state. You can find instructions by choosing
the link for your code from the list of action required codes in
Amazon MQ action required codes.
Each code references a topic with detailed information, instructions,
and recommendations for how to resolve the issue and prevent future
occurrences.
$sel:actionRequiredInfo:ActionRequired', actionRequired_actionRequiredInfo - Information about the action required to resolve your broker issue when
the broker is in a CRITICAL_ACTION_REQUIRED state.
AvailabilityZone
data AvailabilityZone Source #
Name of the availability zone.
See: newAvailabilityZone smart constructor.
Constructors
| AvailabilityZone' (Maybe Text) |
Instances
newAvailabilityZone :: AvailabilityZone Source #
Create a value of AvailabilityZone 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:name:AvailabilityZone', availabilityZone_name - Id for the availability zone.
BrokerEngineType
data BrokerEngineType Source #
Types of broker engines.
See: newBrokerEngineType smart constructor.
Constructors
| BrokerEngineType' (Maybe EngineType) (Maybe [EngineVersion]) |
Instances
newBrokerEngineType :: BrokerEngineType Source #
Create a value of BrokerEngineType 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:engineType:BrokerEngineType', brokerEngineType_engineType - The broker's engine type.
$sel:engineVersions:BrokerEngineType', brokerEngineType_engineVersions - The list of engine versions.
BrokerInstance
data BrokerInstance Source #
Returns information about all brokers.
See: newBrokerInstance smart constructor.
Instances
newBrokerInstance :: BrokerInstance Source #
Create a value of BrokerInstance 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:consoleURL:BrokerInstance', brokerInstance_consoleURL - The brokers web console URL.
$sel:endpoints:BrokerInstance', brokerInstance_endpoints - The broker's wire-level protocol endpoints.
$sel:ipAddress:BrokerInstance', brokerInstance_ipAddress - The IP address of the Elastic Network Interface (ENI) attached to the
broker. Does not apply to RabbitMQ brokers.
BrokerInstanceOption
data BrokerInstanceOption Source #
Option for host instance type.
See: newBrokerInstanceOption smart constructor.
Constructors
| BrokerInstanceOption' (Maybe [AvailabilityZone]) (Maybe EngineType) (Maybe Text) (Maybe BrokerStorageType) (Maybe [DeploymentMode]) (Maybe [Text]) |
Instances
newBrokerInstanceOption :: BrokerInstanceOption Source #
Create a value of BrokerInstanceOption 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:availabilityZones:BrokerInstanceOption', brokerInstanceOption_availabilityZones - The list of available az.
$sel:engineType:BrokerInstanceOption', brokerInstanceOption_engineType - The broker's engine type.
$sel:hostInstanceType:BrokerInstanceOption', brokerInstanceOption_hostInstanceType - The broker's instance type.
$sel:storageType:BrokerInstanceOption', brokerInstanceOption_storageType - The broker's storage type.
$sel:supportedDeploymentModes:BrokerInstanceOption', brokerInstanceOption_supportedDeploymentModes - The list of supported deployment modes.
$sel:supportedEngineVersions:BrokerInstanceOption', brokerInstanceOption_supportedEngineVersions - The list of supported engine versions.
BrokerSummary
data BrokerSummary Source #
Returns information about all brokers.
See: newBrokerSummary smart constructor.
Constructors
| BrokerSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe BrokerState) (Maybe ISO8601) (Maybe Text) DeploymentMode EngineType |
Instances
Arguments
| :: DeploymentMode | |
| -> EngineType | |
| -> BrokerSummary |
Create a value of BrokerSummary 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:brokerArn:BrokerSummary', brokerSummary_brokerArn - The broker's Amazon Resource Name (ARN).
$sel:brokerId:BrokerSummary', brokerSummary_brokerId - The unique ID that Amazon MQ generates for the broker.
$sel:brokerName:BrokerSummary', brokerSummary_brokerName - The broker's name. This value is unique in your AWS account, 1-50
characters long, and containing only letters, numbers, dashes, and
underscores, and must not contain white spaces, brackets, wildcard
characters, or special characters.
$sel:brokerState:BrokerSummary', brokerSummary_brokerState - The broker's status.
$sel:created:BrokerSummary', brokerSummary_created - The time when the broker was created.
$sel:hostInstanceType:BrokerSummary', brokerSummary_hostInstanceType - The broker's instance type.
$sel:deploymentMode:BrokerSummary', brokerSummary_deploymentMode - The broker's deployment mode.
$sel:engineType:BrokerSummary', brokerSummary_engineType - The type of broker engine.
Configuration
data Configuration Source #
Returns information about all configurations.
See: newConfiguration smart constructor.
Constructors
| Configuration' (Maybe (HashMap Text Text)) Text Text ConfigurationRevision AuthenticationStrategy EngineType Text Text Text ISO8601 |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ConfigurationRevision | |
| -> AuthenticationStrategy | |
| -> EngineType | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> Configuration |
Create a value of Configuration 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:tags:Configuration', configuration_tags - The list of all tags associated with this configuration.
Configuration, configuration_description - Required. The description of the configuration.
$sel:engineVersion:Configuration', configuration_engineVersion - Required. The broker engine's version. For a list of supported engine
versions, see,
Supported engines.
$sel:latestRevision:Configuration', configuration_latestRevision - Required. The latest revision of the configuration.
$sel:authenticationStrategy:Configuration', configuration_authenticationStrategy - Optional. The authentication strategy associated with the configuration.
The default is SIMPLE.
$sel:engineType:Configuration', configuration_engineType - Required. The type of broker engine. Currently, Amazon MQ supports
ACTIVEMQ and RABBITMQ.
$sel:id:Configuration', configuration_id - Required. The unique ID that Amazon MQ generates for the configuration.
$sel:arn:Configuration', configuration_arn - Required. The ARN of the configuration.
$sel:name:Configuration', configuration_name - Required. The name of the configuration. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 1-150 characters long.
Configuration, configuration_created - Required. The date and time of the configuration revision.
ConfigurationId
data ConfigurationId Source #
A list of information about the configuration.
Does not apply to RabbitMQ brokers.
See: newConfigurationId smart constructor.
Constructors
| ConfigurationId' (Maybe Int) Text |
Instances
Arguments
| :: Text | |
| -> ConfigurationId |
Create a value of ConfigurationId 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:revision:ConfigurationId', configurationId_revision - The revision number of the configuration.
$sel:id:ConfigurationId', configurationId_id - Required. The unique ID that Amazon MQ generates for the configuration.
ConfigurationRevision
data ConfigurationRevision Source #
Returns information about the specified configuration revision.
See: newConfigurationRevision smart constructor.
Constructors
| ConfigurationRevision' (Maybe Text) Int ISO8601 |
Instances
newConfigurationRevision Source #
Arguments
| :: Int | |
| -> UTCTime | |
| -> ConfigurationRevision |
Create a value of ConfigurationRevision 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:description:ConfigurationRevision', configurationRevision_description - The description of the configuration revision.
$sel:revision:ConfigurationRevision', configurationRevision_revision - Required. The revision number of the configuration.
$sel:created:ConfigurationRevision', configurationRevision_created - Required. The date and time of the configuration revision.
Configurations
data Configurations Source #
Broker configuration information
See: newConfigurations smart constructor.
Constructors
| Configurations' (Maybe ConfigurationId) (Maybe [ConfigurationId]) (Maybe ConfigurationId) |
Instances
newConfigurations :: Configurations Source #
Create a value of Configurations 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:current:Configurations', configurations_current - The broker's current configuration.
$sel:history:Configurations', configurations_history - The history of configurations applied to the broker.
$sel:pending:Configurations', configurations_pending - The broker's pending configuration.
EncryptionOptions
data EncryptionOptions Source #
Does not apply to RabbitMQ brokers.
Encryption options for the broker.
See: newEncryptionOptions smart constructor.
Constructors
| EncryptionOptions' (Maybe Text) Bool |
Instances
Arguments
| :: Bool | |
| -> EncryptionOptions |
Create a value of EncryptionOptions 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:kmsKeyId:EncryptionOptions', encryptionOptions_kmsKeyId - The customer master key (CMK) to use for the AWS Key Management Service
(KMS). This key is used to encrypt your data at rest. If not provided,
Amazon MQ will use a default CMK to encrypt your data.
$sel:useAwsOwnedKey:EncryptionOptions', encryptionOptions_useAwsOwnedKey - Enables the use of an AWS owned CMK using AWS Key Management Service
(KMS). Set to true by default, if no value is provided, for example, for
RabbitMQ brokers.
EngineVersion
data EngineVersion Source #
Id of the engine version.
See: newEngineVersion smart constructor.
Constructors
| EngineVersion' (Maybe Text) |
Instances
newEngineVersion :: EngineVersion Source #
Create a value of EngineVersion 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:name:EngineVersion', engineVersion_name - Id for the version.
LdapServerMetadataInput
data LdapServerMetadataInput Source #
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
Does not apply to RabbitMQ brokers.
See: newLdapServerMetadataInput smart constructor.
Constructors
| LdapServerMetadataInput' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) [Text] Text Text Text Text Text Text |
Instances
newLdapServerMetadataInput Source #
Create a value of LdapServerMetadataInput 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:roleName:LdapServerMetadataInput', ldapServerMetadataInput_roleName - Specifies the LDAP attribute that identifies the group name attribute in
the object returned from the group membership query.
$sel:roleSearchSubtree:LdapServerMetadataInput', ldapServerMetadataInput_roleSearchSubtree - The directory search scope for the role. If set to true, scope is to
search the entire subtree.
$sel:userRoleName:LdapServerMetadataInput', ldapServerMetadataInput_userRoleName - Specifies the name of the LDAP attribute for the user group membership.
$sel:userSearchSubtree:LdapServerMetadataInput', ldapServerMetadataInput_userSearchSubtree - The directory search scope for the user. If set to true, scope is to
search the entire subtree.
$sel:hosts:LdapServerMetadataInput', ldapServerMetadataInput_hosts - Specifies the location of the LDAP server such as AWS Directory Service
for Microsoft Active Directory . Optional failover server.
$sel:userSearchMatching:LdapServerMetadataInput', ldapServerMetadataInput_userSearchMatching - The LDAP search filter used to find users within the userBase. The
client's username is substituted into the {0} placeholder in the search
filter. For example, if this option is set to (uid={0}) and the received
username is janedoe, the search filter becomes (uid=janedoe) after
string substitution. It will result in matching an entry like
uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
$sel:userBase:LdapServerMetadataInput', ldapServerMetadataInput_userBase - Select a particular subtree of the directory information tree (DIT) to
search for user entries. The subtree is specified by a DN, which
specifies the base node of the subtree. For example, by setting this
option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for
user entries is restricted to the subtree beneath ou=Users, ou=corp,
dc=corp, dc=example, dc=com.
$sel:roleSearchMatching:LdapServerMetadataInput', ldapServerMetadataInput_roleSearchMatching - The LDAP search filter used to find roles within the roleBase. The
distinguished name of the user matched by userSearchMatching is
substituted into the {0} placeholder in the search filter. The client's
username is substituted into the {1} placeholder. For example, if you
set this option to (member=uid={1})for the user janedoe, the search
filter becomes (member=uid=janedoe) after string substitution. It
matches all role entries that have a member attribute equal to
uid=janedoe under the subtree selected by the roleBase.
$sel:serviceAccountUsername:LdapServerMetadataInput', ldapServerMetadataInput_serviceAccountUsername - Service account username. A service account is an account in your LDAP
server that has access to initiate a connection. For example,
cn=admin,dc=corp, dc=example, dc=com.
$sel:roleBase:LdapServerMetadataInput', ldapServerMetadataInput_roleBase - The distinguished name of the node in the directory information tree
(DIT) to search for roles or groups. For example, ou=group, ou=corp,
dc=corp, dc=example, dc=com.
$sel:serviceAccountPassword:LdapServerMetadataInput', ldapServerMetadataInput_serviceAccountPassword - Service account password. A service account is an account in your LDAP
server that has access to initiate a connection. For example,
cn=admin,dc=corp, dc=example, dc=com.
LdapServerMetadataOutput
data LdapServerMetadataOutput Source #
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker.
See: newLdapServerMetadataOutput smart constructor.
Constructors
| LdapServerMetadataOutput' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Bool) [Text] Text Text Text Text Text |
Instances
newLdapServerMetadataOutput Source #
Create a value of LdapServerMetadataOutput 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:roleName:LdapServerMetadataOutput', ldapServerMetadataOutput_roleName - Specifies the LDAP attribute that identifies the group name attribute in
the object returned from the group membership query.
$sel:roleSearchSubtree:LdapServerMetadataOutput', ldapServerMetadataOutput_roleSearchSubtree - The directory search scope for the role. If set to true, scope is to
search the entire subtree.
$sel:userRoleName:LdapServerMetadataOutput', ldapServerMetadataOutput_userRoleName - Specifies the name of the LDAP attribute for the user group membership.
$sel:userSearchSubtree:LdapServerMetadataOutput', ldapServerMetadataOutput_userSearchSubtree - The directory search scope for the user. If set to true, scope is to
search the entire subtree.
$sel:hosts:LdapServerMetadataOutput', ldapServerMetadataOutput_hosts - Specifies the location of the LDAP server such as AWS Directory Service
for Microsoft Active Directory . Optional failover server.
$sel:userSearchMatching:LdapServerMetadataOutput', ldapServerMetadataOutput_userSearchMatching - The LDAP search filter used to find users within the userBase. The
client's username is substituted into the {0} placeholder in the search
filter. For example, if this option is set to (uid={0}) and the received
username is janedoe, the search filter becomes (uid=janedoe) after
string substitution. It will result in matching an entry like
uid=janedoe, ou=Users,ou=corp, dc=corp, dc=example, dc=com.
$sel:userBase:LdapServerMetadataOutput', ldapServerMetadataOutput_userBase - Select a particular subtree of the directory information tree (DIT) to
search for user entries. The subtree is specified by a DN, which
specifies the base node of the subtree. For example, by setting this
option to ou=Users,ou=corp, dc=corp, dc=example, dc=com, the search for
user entries is restricted to the subtree beneath ou=Users, ou=corp,
dc=corp, dc=example, dc=com.
$sel:roleSearchMatching:LdapServerMetadataOutput', ldapServerMetadataOutput_roleSearchMatching - The LDAP search filter used to find roles within the roleBase. The
distinguished name of the user matched by userSearchMatching is
substituted into the {0} placeholder in the search filter. The client's
username is substituted into the {1} placeholder. For example, if you
set this option to (member=uid={1})for the user janedoe, the search
filter becomes (member=uid=janedoe) after string substitution. It
matches all role entries that have a member attribute equal to
uid=janedoe under the subtree selected by the roleBase.
$sel:serviceAccountUsername:LdapServerMetadataOutput', ldapServerMetadataOutput_serviceAccountUsername - Service account username. A service account is an account in your LDAP
server that has access to initiate a connection. For example,
cn=admin,dc=corp, dc=example, dc=com.
$sel:roleBase:LdapServerMetadataOutput', ldapServerMetadataOutput_roleBase - The distinguished name of the node in the directory information tree
(DIT) to search for roles or groups. For example, ou=group, ou=corp,
dc=corp, dc=example, dc=com.
Logs
The list of information about logs to be enabled for the specified broker.
See: newLogs smart constructor.
Instances
| FromJSON Logs Source # | |
| ToJSON Logs Source # | |
Defined in Amazonka.MQ.Types.Logs | |
| Generic Logs Source # | |
| Read Logs Source # | |
| Show Logs Source # | |
| NFData Logs Source # | |
Defined in Amazonka.MQ.Types.Logs | |
| Eq Logs Source # | |
| Hashable Logs Source # | |
Defined in Amazonka.MQ.Types.Logs | |
| type Rep Logs Source # | |
Defined in Amazonka.MQ.Types.Logs type Rep Logs = D1 ('MetaData "Logs" "Amazonka.MQ.Types.Logs" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "Logs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "audit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "general") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) | |
Create a value of Logs 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:audit:Logs', logs_audit - Enables audit logging. Every user management action made using JMX or
the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
$sel:general:Logs', logs_general - Enables general logging.
LogsSummary
data LogsSummary Source #
The list of information about logs currently enabled and pending to be deployed for the specified broker.
See: newLogsSummary smart constructor.
Constructors
| LogsSummary' (Maybe Bool) (Maybe Text) (Maybe PendingLogs) Text Bool |
Instances
Arguments
| :: Text | |
| -> Bool | |
| -> LogsSummary |
Create a value of LogsSummary 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:
LogsSummary, logsSummary_audit - Enables audit logging. Every user management action made using JMX or
the ActiveMQ Web Console is logged.
$sel:auditLogGroup:LogsSummary', logsSummary_auditLogGroup - The location of the CloudWatch Logs log group where audit logs are sent.
$sel:pending:LogsSummary', logsSummary_pending - The list of information about logs pending to be deployed for the
specified broker.
$sel:generalLogGroup:LogsSummary', logsSummary_generalLogGroup - The location of the CloudWatch Logs log group where general logs are
sent.
LogsSummary, logsSummary_general - Enables general logging.
PendingLogs
data PendingLogs Source #
The list of information about logs to be enabled for the specified broker.
See: newPendingLogs smart constructor.
Constructors
| PendingLogs' (Maybe Bool) (Maybe Bool) |
Instances
newPendingLogs :: PendingLogs Source #
Create a value of PendingLogs 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:audit:PendingLogs', pendingLogs_audit - Enables audit logging. Every user management action made using JMX or
the ActiveMQ Web Console is logged.
$sel:general:PendingLogs', pendingLogs_general - Enables general logging.
SanitizationWarning
data SanitizationWarning Source #
Returns information about the XML element or attribute that was sanitized in the configuration.
See: newSanitizationWarning smart constructor.
Constructors
| SanitizationWarning' (Maybe Text) (Maybe Text) SanitizationWarningReason |
Instances
newSanitizationWarning Source #
Create a value of SanitizationWarning 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:attributeName:SanitizationWarning', sanitizationWarning_attributeName - The name of the XML attribute that has been sanitized.
$sel:elementName:SanitizationWarning', sanitizationWarning_elementName - The name of the XML element that has been sanitized.
$sel:reason:SanitizationWarning', sanitizationWarning_reason - Required. The reason for which the XML elements or attributes were
sanitized.
User
A user associated with the broker. For RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
See: newUser smart constructor.
Instances
| ToJSON User Source # | |
Defined in Amazonka.MQ.Types.User | |
| Generic User Source # | |
| Read User Source # | |
| Show User Source # | |
| NFData User Source # | |
Defined in Amazonka.MQ.Types.User | |
| Eq User Source # | |
| Hashable User Source # | |
Defined in Amazonka.MQ.Types.User | |
| type Rep User Source # | |
Defined in Amazonka.MQ.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.MQ.Types.User" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consoleAccess") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of User 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:consoleAccess:User', user_consoleAccess - Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does
not apply to RabbitMQ brokers.
$sel:groups:User', user_groups - The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters
long. Does not apply to RabbitMQ brokers.
$sel:username:User', user_username - important>
Amazon MQ for ActiveMQ
For ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
/important>
Amazon MQ for RabbitMQ
For RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long.
$sel:password:User', user_password - Required. The password of the user. This value must be at least 12
characters long, must contain at least 4 unique characters, and must not
contain commas, colons, or equal signs (,:=).
UserPendingChanges
data UserPendingChanges Source #
Returns information about the status of the changes pending for the ActiveMQ user.
See: newUserPendingChanges smart constructor.
Constructors
| UserPendingChanges' (Maybe Bool) (Maybe [Text]) ChangeType |
Instances
newUserPendingChanges Source #
Create a value of UserPendingChanges 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:consoleAccess:UserPendingChanges', userPendingChanges_consoleAccess - Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
$sel:groups:UserPendingChanges', userPendingChanges_groups - The list of groups (20 maximum) to which the ActiveMQ user belongs. This
value can contain only alphanumeric characters, dashes, periods,
underscores, and tildes (- . _ ~). This value must be 2-100 characters
long.
$sel:pendingChange:UserPendingChanges', userPendingChanges_pendingChange - Required. The type of change pending for the ActiveMQ user.
UserSummary
data UserSummary Source #
Returns a list of all broker users. Does not apply to RabbitMQ brokers.
See: newUserSummary smart constructor.
Constructors
| UserSummary' (Maybe ChangeType) Text |
Instances
Arguments
| :: Text | |
| -> UserSummary |
Create a value of UserSummary 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:pendingChange:UserSummary', userSummary_pendingChange - The type of change pending for the broker user.
$sel:username:UserSummary', userSummary_username - Required. The username of the broker user. This value can contain only
alphanumeric characters, dashes, periods, underscores, and tildes (- . _
~). This value must be 2-100 characters long.
WeeklyStartTime
data WeeklyStartTime Source #
The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.
See: newWeeklyStartTime smart constructor.
Constructors
| WeeklyStartTime' (Maybe Text) Text DayOfWeek |
Instances
Arguments
| :: Text | |
| -> DayOfWeek | |
| -> WeeklyStartTime |
Create a value of WeeklyStartTime 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:timeZone:WeeklyStartTime', weeklyStartTime_timeZone - The time zone, UTC by default, in either the Country/City format, or
the UTC offset format.
$sel:timeOfDay:WeeklyStartTime', weeklyStartTime_timeOfDay - Required. The time, in 24-hour format.
$sel:dayOfWeek:WeeklyStartTime', weeklyStartTime_dayOfWeek - Required. The day of the week.