| 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.Types
Contents
- Service Configuration
- Errors
- 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
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
- 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' {}
- newActionRequired :: ActionRequired
- actionRequired_actionRequiredCode :: Lens' ActionRequired (Maybe Text)
- actionRequired_actionRequiredInfo :: Lens' ActionRequired (Maybe Text)
- data AvailabilityZone = AvailabilityZone' {}
- newAvailabilityZone :: AvailabilityZone
- availabilityZone_name :: Lens' AvailabilityZone (Maybe Text)
- data BrokerEngineType = BrokerEngineType' {}
- newBrokerEngineType :: BrokerEngineType
- brokerEngineType_engineType :: Lens' BrokerEngineType (Maybe EngineType)
- brokerEngineType_engineVersions :: Lens' BrokerEngineType (Maybe [EngineVersion])
- data BrokerInstance = BrokerInstance' {}
- newBrokerInstance :: BrokerInstance
- brokerInstance_consoleURL :: Lens' BrokerInstance (Maybe Text)
- brokerInstance_endpoints :: Lens' BrokerInstance (Maybe [Text])
- brokerInstance_ipAddress :: Lens' BrokerInstance (Maybe Text)
- data BrokerInstanceOption = BrokerInstanceOption' {}
- newBrokerInstanceOption :: BrokerInstanceOption
- brokerInstanceOption_availabilityZones :: Lens' BrokerInstanceOption (Maybe [AvailabilityZone])
- brokerInstanceOption_engineType :: Lens' BrokerInstanceOption (Maybe EngineType)
- brokerInstanceOption_hostInstanceType :: Lens' BrokerInstanceOption (Maybe Text)
- brokerInstanceOption_storageType :: Lens' BrokerInstanceOption (Maybe BrokerStorageType)
- brokerInstanceOption_supportedDeploymentModes :: Lens' BrokerInstanceOption (Maybe [DeploymentMode])
- brokerInstanceOption_supportedEngineVersions :: Lens' BrokerInstanceOption (Maybe [Text])
- data BrokerSummary = BrokerSummary' {}
- newBrokerSummary :: DeploymentMode -> EngineType -> BrokerSummary
- brokerSummary_brokerArn :: Lens' BrokerSummary (Maybe Text)
- brokerSummary_brokerId :: Lens' BrokerSummary (Maybe Text)
- brokerSummary_brokerName :: Lens' BrokerSummary (Maybe Text)
- brokerSummary_brokerState :: Lens' BrokerSummary (Maybe BrokerState)
- brokerSummary_created :: Lens' BrokerSummary (Maybe UTCTime)
- brokerSummary_hostInstanceType :: Lens' BrokerSummary (Maybe Text)
- brokerSummary_deploymentMode :: Lens' BrokerSummary DeploymentMode
- brokerSummary_engineType :: Lens' BrokerSummary EngineType
- data Configuration = Configuration' {}
- newConfiguration :: Text -> Text -> ConfigurationRevision -> AuthenticationStrategy -> EngineType -> Text -> Text -> Text -> UTCTime -> Configuration
- configuration_tags :: Lens' Configuration (Maybe (HashMap Text Text))
- configuration_description :: Lens' Configuration Text
- configuration_engineVersion :: Lens' Configuration Text
- configuration_latestRevision :: Lens' Configuration ConfigurationRevision
- configuration_authenticationStrategy :: Lens' Configuration AuthenticationStrategy
- configuration_engineType :: Lens' Configuration EngineType
- configuration_id :: Lens' Configuration Text
- configuration_arn :: Lens' Configuration Text
- configuration_name :: Lens' Configuration Text
- configuration_created :: Lens' Configuration UTCTime
- data ConfigurationId = ConfigurationId' {}
- newConfigurationId :: Text -> ConfigurationId
- configurationId_revision :: Lens' ConfigurationId (Maybe Int)
- configurationId_id :: Lens' ConfigurationId Text
- data ConfigurationRevision = ConfigurationRevision' {}
- newConfigurationRevision :: Int -> UTCTime -> ConfigurationRevision
- configurationRevision_description :: Lens' ConfigurationRevision (Maybe Text)
- configurationRevision_revision :: Lens' ConfigurationRevision Int
- configurationRevision_created :: Lens' ConfigurationRevision UTCTime
- data Configurations = Configurations' {}
- newConfigurations :: Configurations
- configurations_current :: Lens' Configurations (Maybe ConfigurationId)
- configurations_history :: Lens' Configurations (Maybe [ConfigurationId])
- configurations_pending :: Lens' Configurations (Maybe ConfigurationId)
- data EncryptionOptions = EncryptionOptions' {
- kmsKeyId :: Maybe Text
- useAwsOwnedKey :: Bool
- newEncryptionOptions :: Bool -> EncryptionOptions
- encryptionOptions_kmsKeyId :: Lens' EncryptionOptions (Maybe Text)
- encryptionOptions_useAwsOwnedKey :: Lens' EncryptionOptions Bool
- data EngineVersion = EngineVersion' {}
- newEngineVersion :: EngineVersion
- engineVersion_name :: Lens' EngineVersion (Maybe Text)
- data LdapServerMetadataInput = LdapServerMetadataInput' {}
- newLdapServerMetadataInput :: Text -> Text -> Text -> Text -> Text -> Text -> LdapServerMetadataInput
- ldapServerMetadataInput_roleName :: Lens' LdapServerMetadataInput (Maybe Text)
- ldapServerMetadataInput_roleSearchSubtree :: Lens' LdapServerMetadataInput (Maybe Bool)
- ldapServerMetadataInput_userRoleName :: Lens' LdapServerMetadataInput (Maybe Text)
- ldapServerMetadataInput_userSearchSubtree :: Lens' LdapServerMetadataInput (Maybe Bool)
- ldapServerMetadataInput_hosts :: Lens' LdapServerMetadataInput [Text]
- ldapServerMetadataInput_userSearchMatching :: Lens' LdapServerMetadataInput Text
- ldapServerMetadataInput_userBase :: Lens' LdapServerMetadataInput Text
- ldapServerMetadataInput_roleSearchMatching :: Lens' LdapServerMetadataInput Text
- ldapServerMetadataInput_serviceAccountUsername :: Lens' LdapServerMetadataInput Text
- ldapServerMetadataInput_roleBase :: Lens' LdapServerMetadataInput Text
- ldapServerMetadataInput_serviceAccountPassword :: Lens' LdapServerMetadataInput Text
- data LdapServerMetadataOutput = LdapServerMetadataOutput' {}
- newLdapServerMetadataOutput :: Text -> Text -> Text -> Text -> Text -> LdapServerMetadataOutput
- ldapServerMetadataOutput_roleName :: Lens' LdapServerMetadataOutput (Maybe Text)
- ldapServerMetadataOutput_roleSearchSubtree :: Lens' LdapServerMetadataOutput (Maybe Bool)
- ldapServerMetadataOutput_userRoleName :: Lens' LdapServerMetadataOutput (Maybe Text)
- ldapServerMetadataOutput_userSearchSubtree :: Lens' LdapServerMetadataOutput (Maybe Bool)
- ldapServerMetadataOutput_hosts :: Lens' LdapServerMetadataOutput [Text]
- ldapServerMetadataOutput_userSearchMatching :: Lens' LdapServerMetadataOutput Text
- ldapServerMetadataOutput_userBase :: Lens' LdapServerMetadataOutput Text
- ldapServerMetadataOutput_roleSearchMatching :: Lens' LdapServerMetadataOutput Text
- ldapServerMetadataOutput_serviceAccountUsername :: Lens' LdapServerMetadataOutput Text
- ldapServerMetadataOutput_roleBase :: Lens' LdapServerMetadataOutput Text
- data Logs = Logs' {}
- newLogs :: Logs
- logs_audit :: Lens' Logs (Maybe Bool)
- logs_general :: Lens' Logs (Maybe Bool)
- data LogsSummary = LogsSummary' {
- audit :: Maybe Bool
- auditLogGroup :: Maybe Text
- pending :: Maybe PendingLogs
- generalLogGroup :: Text
- general :: Bool
- newLogsSummary :: Text -> Bool -> LogsSummary
- logsSummary_audit :: Lens' LogsSummary (Maybe Bool)
- logsSummary_auditLogGroup :: Lens' LogsSummary (Maybe Text)
- logsSummary_pending :: Lens' LogsSummary (Maybe PendingLogs)
- logsSummary_generalLogGroup :: Lens' LogsSummary Text
- logsSummary_general :: Lens' LogsSummary Bool
- data PendingLogs = PendingLogs' {}
- newPendingLogs :: PendingLogs
- pendingLogs_audit :: Lens' PendingLogs (Maybe Bool)
- pendingLogs_general :: Lens' PendingLogs (Maybe Bool)
- data SanitizationWarning = SanitizationWarning' {}
- newSanitizationWarning :: SanitizationWarningReason -> SanitizationWarning
- sanitizationWarning_attributeName :: Lens' SanitizationWarning (Maybe Text)
- sanitizationWarning_elementName :: Lens' SanitizationWarning (Maybe Text)
- sanitizationWarning_reason :: Lens' SanitizationWarning SanitizationWarningReason
- data User = User' {}
- newUser :: Text -> Text -> User
- user_consoleAccess :: Lens' User (Maybe Bool)
- user_groups :: Lens' User (Maybe [Text])
- user_username :: Lens' User Text
- user_password :: Lens' User Text
- data UserPendingChanges = UserPendingChanges' {
- consoleAccess :: Maybe Bool
- groups :: Maybe [Text]
- pendingChange :: ChangeType
- newUserPendingChanges :: ChangeType -> UserPendingChanges
- userPendingChanges_consoleAccess :: Lens' UserPendingChanges (Maybe Bool)
- userPendingChanges_groups :: Lens' UserPendingChanges (Maybe [Text])
- userPendingChanges_pendingChange :: Lens' UserPendingChanges ChangeType
- data UserSummary = UserSummary' {}
- newUserSummary :: Text -> UserSummary
- userSummary_pendingChange :: Lens' UserSummary (Maybe ChangeType)
- userSummary_username :: Lens' UserSummary Text
- data WeeklyStartTime = WeeklyStartTime' {}
- newWeeklyStartTime :: Text -> DayOfWeek -> WeeklyStartTime
- weeklyStartTime_timeZone :: Lens' WeeklyStartTime (Maybe Text)
- weeklyStartTime_timeOfDay :: Lens' WeeklyStartTime Text
- weeklyStartTime_dayOfWeek :: Lens' WeeklyStartTime DayOfWeek
Service Configuration
defaultService :: Service Source #
API version 2017-11-27 of the Amazon MQ SDK configuration.
Errors
_BadRequestException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
_ConflictException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
_ForbiddenException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
_InternalServerErrorException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
_NotFoundException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
Returns information about an error.
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' | |
Fields
| |
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.
actionRequired_actionRequiredCode :: Lens' ActionRequired (Maybe Text) Source #
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.
actionRequired_actionRequiredInfo :: Lens' ActionRequired (Maybe Text) Source #
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' | |
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.
availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #
Id for the availability zone.
BrokerEngineType
data BrokerEngineType Source #
Types of broker engines.
See: newBrokerEngineType smart constructor.
Constructors
| BrokerEngineType' | |
Fields
| |
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.
brokerEngineType_engineType :: Lens' BrokerEngineType (Maybe EngineType) Source #
The broker's engine type.
brokerEngineType_engineVersions :: Lens' BrokerEngineType (Maybe [EngineVersion]) Source #
The list of engine versions.
BrokerInstance
data BrokerInstance Source #
Returns information about all brokers.
See: newBrokerInstance smart constructor.
Constructors
| BrokerInstance' | |
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.
brokerInstance_consoleURL :: Lens' BrokerInstance (Maybe Text) Source #
The brokers web console URL.
brokerInstance_endpoints :: Lens' BrokerInstance (Maybe [Text]) Source #
The broker's wire-level protocol endpoints.
brokerInstance_ipAddress :: Lens' BrokerInstance (Maybe Text) Source #
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' | |
Fields
| |
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.
brokerInstanceOption_availabilityZones :: Lens' BrokerInstanceOption (Maybe [AvailabilityZone]) Source #
The list of available az.
brokerInstanceOption_engineType :: Lens' BrokerInstanceOption (Maybe EngineType) Source #
The broker's engine type.
brokerInstanceOption_hostInstanceType :: Lens' BrokerInstanceOption (Maybe Text) Source #
The broker's instance type.
brokerInstanceOption_storageType :: Lens' BrokerInstanceOption (Maybe BrokerStorageType) Source #
The broker's storage type.
brokerInstanceOption_supportedDeploymentModes :: Lens' BrokerInstanceOption (Maybe [DeploymentMode]) Source #
The list of supported deployment modes.
brokerInstanceOption_supportedEngineVersions :: Lens' BrokerInstanceOption (Maybe [Text]) Source #
The list of supported engine versions.
BrokerSummary
data BrokerSummary Source #
Returns information about all brokers.
See: newBrokerSummary smart constructor.
Constructors
| BrokerSummary' | |
Fields
| |
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.
brokerSummary_brokerArn :: Lens' BrokerSummary (Maybe Text) Source #
The broker's Amazon Resource Name (ARN).
brokerSummary_brokerId :: Lens' BrokerSummary (Maybe Text) Source #
The unique ID that Amazon MQ generates for the broker.
brokerSummary_brokerName :: Lens' BrokerSummary (Maybe Text) Source #
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.
brokerSummary_brokerState :: Lens' BrokerSummary (Maybe BrokerState) Source #
The broker's status.
brokerSummary_created :: Lens' BrokerSummary (Maybe UTCTime) Source #
The time when the broker was created.
brokerSummary_hostInstanceType :: Lens' BrokerSummary (Maybe Text) Source #
The broker's instance type.
brokerSummary_deploymentMode :: Lens' BrokerSummary DeploymentMode Source #
The broker's deployment mode.
brokerSummary_engineType :: Lens' BrokerSummary EngineType Source #
The type of broker engine.
Configuration
data Configuration Source #
Returns information about all configurations.
See: newConfiguration smart constructor.
Constructors
| Configuration' | |
Fields
| |
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.
configuration_tags :: Lens' Configuration (Maybe (HashMap Text Text)) Source #
The list of all tags associated with this configuration.
configuration_description :: Lens' Configuration Text Source #
Required. The description of the configuration.
configuration_engineVersion :: Lens' Configuration Text Source #
Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.
configuration_latestRevision :: Lens' Configuration ConfigurationRevision Source #
Required. The latest revision of the configuration.
configuration_authenticationStrategy :: Lens' Configuration AuthenticationStrategy Source #
Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
configuration_engineType :: Lens' Configuration EngineType Source #
Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
configuration_id :: Lens' Configuration Text Source #
Required. The unique ID that Amazon MQ generates for the configuration.
configuration_arn :: Lens' Configuration Text Source #
Required. The ARN of the configuration.
configuration_name :: Lens' Configuration Text Source #
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_created :: Lens' Configuration UTCTime Source #
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' | |
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.
configurationId_revision :: Lens' ConfigurationId (Maybe Int) Source #
The revision number of the configuration.
configurationId_id :: Lens' ConfigurationId Text Source #
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' | |
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.
configurationRevision_description :: Lens' ConfigurationRevision (Maybe Text) Source #
The description of the configuration revision.
configurationRevision_revision :: Lens' ConfigurationRevision Int Source #
Required. The revision number of the configuration.
configurationRevision_created :: Lens' ConfigurationRevision UTCTime Source #
Required. The date and time of the configuration revision.
Configurations
data Configurations Source #
Broker configuration information
See: newConfigurations smart constructor.
Constructors
| Configurations' | |
Fields
| |
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.
configurations_current :: Lens' Configurations (Maybe ConfigurationId) Source #
The broker's current configuration.
configurations_history :: Lens' Configurations (Maybe [ConfigurationId]) Source #
The history of configurations applied to the broker.
configurations_pending :: Lens' Configurations (Maybe ConfigurationId) Source #
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' | |
Fields
| |
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.
encryptionOptions_kmsKeyId :: Lens' EncryptionOptions (Maybe Text) Source #
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.
encryptionOptions_useAwsOwnedKey :: Lens' EncryptionOptions Bool Source #
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' | |
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.
engineVersion_name :: Lens' EngineVersion (Maybe Text) Source #
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' | |
Fields
| |
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.
ldapServerMetadataInput_roleName :: Lens' LdapServerMetadataInput (Maybe Text) Source #
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
ldapServerMetadataInput_roleSearchSubtree :: Lens' LdapServerMetadataInput (Maybe Bool) Source #
The directory search scope for the role. If set to true, scope is to search the entire subtree.
ldapServerMetadataInput_userRoleName :: Lens' LdapServerMetadataInput (Maybe Text) Source #
Specifies the name of the LDAP attribute for the user group membership.
ldapServerMetadataInput_userSearchSubtree :: Lens' LdapServerMetadataInput (Maybe Bool) Source #
The directory search scope for the user. If set to true, scope is to search the entire subtree.
ldapServerMetadataInput_hosts :: Lens' LdapServerMetadataInput [Text] Source #
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
ldapServerMetadataInput_userSearchMatching :: Lens' LdapServerMetadataInput Text Source #
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.
ldapServerMetadataInput_userBase :: Lens' LdapServerMetadataInput Text Source #
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.
ldapServerMetadataInput_roleSearchMatching :: Lens' LdapServerMetadataInput Text Source #
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.
ldapServerMetadataInput_serviceAccountUsername :: Lens' LdapServerMetadataInput Text Source #
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.
ldapServerMetadataInput_roleBase :: Lens' LdapServerMetadataInput Text Source #
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.
ldapServerMetadataInput_serviceAccountPassword :: Lens' LdapServerMetadataInput Text Source #
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' | |
Fields
| |
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.
ldapServerMetadataOutput_roleName :: Lens' LdapServerMetadataOutput (Maybe Text) Source #
Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
ldapServerMetadataOutput_roleSearchSubtree :: Lens' LdapServerMetadataOutput (Maybe Bool) Source #
The directory search scope for the role. If set to true, scope is to search the entire subtree.
ldapServerMetadataOutput_userRoleName :: Lens' LdapServerMetadataOutput (Maybe Text) Source #
Specifies the name of the LDAP attribute for the user group membership.
ldapServerMetadataOutput_userSearchSubtree :: Lens' LdapServerMetadataOutput (Maybe Bool) Source #
The directory search scope for the user. If set to true, scope is to search the entire subtree.
ldapServerMetadataOutput_hosts :: Lens' LdapServerMetadataOutput [Text] Source #
Specifies the location of the LDAP server such as AWS Directory Service for Microsoft Active Directory . Optional failover server.
ldapServerMetadataOutput_userSearchMatching :: Lens' LdapServerMetadataOutput Text Source #
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.
ldapServerMetadataOutput_userBase :: Lens' LdapServerMetadataOutput Text Source #
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.
ldapServerMetadataOutput_roleSearchMatching :: Lens' LdapServerMetadataOutput Text Source #
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.
ldapServerMetadataOutput_serviceAccountUsername :: Lens' LdapServerMetadataOutput Text Source #
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.
ldapServerMetadataOutput_roleBase :: Lens' LdapServerMetadataOutput Text Source #
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.
Constructors
| Logs' | |
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.
logs_audit :: Lens' Logs (Maybe Bool) Source #
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Does not apply to RabbitMQ brokers.
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' | |
Fields
| |
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.
logsSummary_audit :: Lens' LogsSummary (Maybe Bool) Source #
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
logsSummary_auditLogGroup :: Lens' LogsSummary (Maybe Text) Source #
The location of the CloudWatch Logs log group where audit logs are sent.
logsSummary_pending :: Lens' LogsSummary (Maybe PendingLogs) Source #
The list of information about logs pending to be deployed for the specified broker.
logsSummary_generalLogGroup :: Lens' LogsSummary Text Source #
The location of the CloudWatch Logs log group where general logs are sent.
logsSummary_general :: Lens' LogsSummary Bool Source #
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' | |
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.
pendingLogs_audit :: Lens' PendingLogs (Maybe Bool) Source #
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
pendingLogs_general :: Lens' PendingLogs (Maybe Bool) Source #
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' | |
Fields
| |
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.
sanitizationWarning_attributeName :: Lens' SanitizationWarning (Maybe Text) Source #
The name of the XML attribute that has been sanitized.
sanitizationWarning_elementName :: Lens' SanitizationWarning (Maybe Text) Source #
The name of the XML element that has been sanitized.
sanitizationWarning_reason :: Lens' SanitizationWarning SanitizationWarningReason Source #
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.
Constructors
| User' | |
Fields
| |
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 (,:=).
user_consoleAccess :: Lens' User (Maybe Bool) Source #
Enables access to the ActiveMQ Web Console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
user_groups :: Lens' User (Maybe [Text]) Source #
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.
user_username :: Lens' User Text Source #
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.
user_password :: Lens' User Text Source #
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' | |
Fields
| |
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.
userPendingChanges_consoleAccess :: Lens' UserPendingChanges (Maybe Bool) Source #
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
userPendingChanges_groups :: Lens' UserPendingChanges (Maybe [Text]) Source #
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.
userPendingChanges_pendingChange :: Lens' UserPendingChanges ChangeType Source #
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' | |
Fields
| |
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.
userSummary_pendingChange :: Lens' UserSummary (Maybe ChangeType) Source #
The type of change pending for the broker user.
userSummary_username :: Lens' UserSummary Text Source #
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' | |
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.
weeklyStartTime_timeZone :: Lens' WeeklyStartTime (Maybe Text) Source #
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
weeklyStartTime_timeOfDay :: Lens' WeeklyStartTime Text Source #
Required. The time, in 24-hour format.
weeklyStartTime_dayOfWeek :: Lens' WeeklyStartTime DayOfWeek Source #
Required. The day of the week.