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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds a pending configuration change to a broker.

Synopsis

data UpdateBroker = UpdateBroker' {
- authenticationStrategy :: Maybe AuthenticationStrategy
- autoMinorVersionUpgrade :: Maybe Bool
- configuration :: Maybe ConfigurationId
- engineVersion :: Maybe Text
- hostInstanceType :: Maybe Text
- ldapServerMetadata :: Maybe LdapServerMetadataInput
- logs :: Maybe Logs
- maintenanceWindowStartTime :: Maybe WeeklyStartTime
- securityGroups :: Maybe [Text]
- brokerId :: Text
}
newUpdateBroker :: Text -> UpdateBroker
updateBroker_authenticationStrategy :: Lens' UpdateBroker (Maybe AuthenticationStrategy)
updateBroker_autoMinorVersionUpgrade :: Lens' UpdateBroker (Maybe Bool)
updateBroker_configuration :: Lens' UpdateBroker (Maybe ConfigurationId)
updateBroker_engineVersion :: Lens' UpdateBroker (Maybe Text)
updateBroker_hostInstanceType :: Lens' UpdateBroker (Maybe Text)
updateBroker_ldapServerMetadata :: Lens' UpdateBroker (Maybe LdapServerMetadataInput)
updateBroker_logs :: Lens' UpdateBroker (Maybe Logs)
updateBroker_maintenanceWindowStartTime :: Lens' UpdateBroker (Maybe WeeklyStartTime)
updateBroker_securityGroups :: Lens' UpdateBroker (Maybe [Text])
updateBroker_brokerId :: Lens' UpdateBroker Text
data UpdateBrokerResponse = UpdateBrokerResponse' {
- authenticationStrategy :: Maybe AuthenticationStrategy
- autoMinorVersionUpgrade :: Maybe Bool
- brokerId :: Maybe Text
- configuration :: Maybe ConfigurationId
- engineVersion :: Maybe Text
- hostInstanceType :: Maybe Text
- ldapServerMetadata :: Maybe LdapServerMetadataOutput
- logs :: Maybe Logs
- maintenanceWindowStartTime :: Maybe WeeklyStartTime
- securityGroups :: Maybe [Text]
- httpStatus :: Int
}
newUpdateBrokerResponse :: Int -> UpdateBrokerResponse
updateBrokerResponse_authenticationStrategy :: Lens' UpdateBrokerResponse (Maybe AuthenticationStrategy)
updateBrokerResponse_autoMinorVersionUpgrade :: Lens' UpdateBrokerResponse (Maybe Bool)
updateBrokerResponse_brokerId :: Lens' UpdateBrokerResponse (Maybe Text)
updateBrokerResponse_configuration :: Lens' UpdateBrokerResponse (Maybe ConfigurationId)
updateBrokerResponse_engineVersion :: Lens' UpdateBrokerResponse (Maybe Text)
updateBrokerResponse_hostInstanceType :: Lens' UpdateBrokerResponse (Maybe Text)
updateBrokerResponse_ldapServerMetadata :: Lens' UpdateBrokerResponse (Maybe LdapServerMetadataOutput)
updateBrokerResponse_logs :: Lens' UpdateBrokerResponse (Maybe Logs)
updateBrokerResponse_maintenanceWindowStartTime :: Lens' UpdateBrokerResponse (Maybe WeeklyStartTime)
updateBrokerResponse_securityGroups :: Lens' UpdateBrokerResponse (Maybe [Text])
updateBrokerResponse_httpStatus :: Lens' UpdateBrokerResponse Int

Creating a Request

data UpdateBroker Source #

Updates the broker using the specified properties.

See: newUpdateBroker smart constructor.

Constructors

UpdateBroker'

Fields

authenticationStrategy :: Maybe AuthenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
autoMinorVersionUpgrade :: Maybe Bool
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.
configuration :: Maybe ConfigurationId
A list of information about the configuration.
engineVersion :: Maybe Text
The broker engine version. For a list of supported engine versions, see Supported engines.
hostInstanceType :: Maybe Text
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
ldapServerMetadata :: Maybe LdapServerMetadataInput
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs :: Maybe Logs
Enables Amazon CloudWatch logging for brokers.
maintenanceWindowStartTime :: Maybe WeeklyStartTime
The parameters that determine the WeeklyStartTime.
securityGroups :: Maybe [Text]
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
brokerId :: Text
The unique ID that Amazon MQ generates for the broker.

Instances

Instances details

ToJSON UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods toJSON :: UpdateBroker -> Value # toEncoding :: UpdateBroker -> Encoding # toJSONList :: [UpdateBroker] -> Value # toEncodingList :: [UpdateBroker] -> Encoding #
ToHeaders UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods toHeaders :: UpdateBroker -> [Header] #
ToPath UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods toPath :: UpdateBroker -> ByteString #
ToQuery UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods toQuery :: UpdateBroker -> QueryString #
AWSRequest UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Associated Types type AWSResponse UpdateBroker # Methods request :: (Service -> Service) -> UpdateBroker -> Request UpdateBroker # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateBroker -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateBroker))) #
Generic UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Associated Types type Rep UpdateBroker :: Type -> Type # Methods from :: UpdateBroker -> Rep UpdateBroker x # to :: Rep UpdateBroker x -> UpdateBroker #
Read UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods readsPrec :: Int -> ReadS UpdateBroker # readList :: ReadS [UpdateBroker] # readPrec :: ReadPrec UpdateBroker # readListPrec :: ReadPrec [UpdateBroker] #
Show UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods showsPrec :: Int -> UpdateBroker -> ShowS # show :: UpdateBroker -> String # showList :: [UpdateBroker] -> ShowS #
NFData UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods rnf :: UpdateBroker -> () #
Eq UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods (==) :: UpdateBroker -> UpdateBroker -> Bool # (/=) :: UpdateBroker -> UpdateBroker -> Bool #
Hashable UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods hashWithSalt :: Int -> UpdateBroker -> Int # hash :: UpdateBroker -> Int #
type AWSResponse UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker type AWSResponse UpdateBroker = UpdateBrokerResponse
type Rep UpdateBroker Source #
Instance details Defined in Amazonka.MQ.UpdateBroker type Rep UpdateBroker = D1 ('MetaData "UpdateBroker" "Amazonka.MQ.UpdateBroker" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "UpdateBroker'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationStrategy)) :: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationId)) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hostInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "ldapServerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LdapServerMetadataInput)) :: S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Logs))) :: (S1 ('MetaSel ('Just "maintenanceWindowStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WeeklyStartTime)) :: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateBroker Source #

Arguments

:: Text	`UpdateBroker`
-> 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.

Request Lenses

updateBroker_authenticationStrategy :: Lens' UpdateBroker (Maybe AuthenticationStrategy) Source #

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

updateBroker_autoMinorVersionUpgrade :: Lens' UpdateBroker (Maybe Bool) Source #

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_configuration :: Lens' UpdateBroker (Maybe ConfigurationId) Source #

A list of information about the configuration.

updateBroker_engineVersion :: Lens' UpdateBroker (Maybe Text) Source #

The broker engine version. For a list of supported engine versions, see Supported engines.

updateBroker_hostInstanceType :: Lens' UpdateBroker (Maybe Text) Source #

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

updateBroker_ldapServerMetadata :: Lens' UpdateBroker (Maybe LdapServerMetadataInput) Source #

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

updateBroker_logs :: Lens' UpdateBroker (Maybe Logs) Source #

Enables Amazon CloudWatch logging for brokers.

updateBroker_maintenanceWindowStartTime :: Lens' UpdateBroker (Maybe WeeklyStartTime) Source #

The parameters that determine the WeeklyStartTime.

updateBroker_securityGroups :: Lens' UpdateBroker (Maybe [Text]) Source #

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

updateBroker_brokerId :: Lens' UpdateBroker Text Source #

The unique ID that Amazon MQ generates for the broker.

Destructuring the Response

data UpdateBrokerResponse Source #

See: newUpdateBrokerResponse smart constructor.

Constructors

UpdateBrokerResponse'

Fields

authenticationStrategy :: Maybe AuthenticationStrategy
Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
autoMinorVersionUpgrade :: Maybe Bool
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.
brokerId :: Maybe Text
Required. The unique ID that Amazon MQ generates for the broker.
configuration :: Maybe ConfigurationId
The ID of the updated configuration.
engineVersion :: Maybe Text
The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
hostInstanceType :: Maybe Text
The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
ldapServerMetadata :: Maybe LdapServerMetadataOutput
Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs :: Maybe Logs
The list of information about logs to be enabled for the specified broker.
maintenanceWindowStartTime :: Maybe WeeklyStartTime
The parameters that determine the WeeklyStartTime.
securityGroups :: Maybe [Text]
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic UpdateBrokerResponse Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Associated Types type Rep UpdateBrokerResponse :: Type -> Type # Methods from :: UpdateBrokerResponse -> Rep UpdateBrokerResponse x # to :: Rep UpdateBrokerResponse x -> UpdateBrokerResponse #
Read UpdateBrokerResponse Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods readsPrec :: Int -> ReadS UpdateBrokerResponse # readList :: ReadS [UpdateBrokerResponse] # readPrec :: ReadPrec UpdateBrokerResponse # readListPrec :: ReadPrec [UpdateBrokerResponse] #
Show UpdateBrokerResponse Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods showsPrec :: Int -> UpdateBrokerResponse -> ShowS # show :: UpdateBrokerResponse -> String # showList :: [UpdateBrokerResponse] -> ShowS #
NFData UpdateBrokerResponse Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods rnf :: UpdateBrokerResponse -> () #
Eq UpdateBrokerResponse Source #
Instance details Defined in Amazonka.MQ.UpdateBroker Methods (==) :: UpdateBrokerResponse -> UpdateBrokerResponse -> Bool # (/=) :: UpdateBrokerResponse -> UpdateBrokerResponse -> Bool #
type Rep UpdateBrokerResponse Source #
Instance details Defined in Amazonka.MQ.UpdateBroker type Rep UpdateBrokerResponse = D1 ('MetaData "UpdateBrokerResponse" "Amazonka.MQ.UpdateBroker" "amazonka-mq-2.0-3ebKNoK022m255Abw9OF0s" 'False) (C1 ('MetaCons "UpdateBrokerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationStrategy)) :: S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationId)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "hostInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ldapServerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LdapServerMetadataOutput)) :: S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Logs)))) :: (S1 ('MetaSel ('Just "maintenanceWindowStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WeeklyStartTime)) :: (S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateBrokerResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateBrokerResponse'`
-> 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.

Response Lenses

updateBrokerResponse_authenticationStrategy :: Lens' UpdateBrokerResponse (Maybe AuthenticationStrategy) Source #

Optional. The authentication strategy used to secure the broker. The default is SIMPLE.

updateBrokerResponse_autoMinorVersionUpgrade :: Lens' UpdateBrokerResponse (Maybe Bool) Source #

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.

updateBrokerResponse_brokerId :: Lens' UpdateBrokerResponse (Maybe Text) Source #

Required. The unique ID that Amazon MQ generates for the broker.

updateBrokerResponse_configuration :: Lens' UpdateBrokerResponse (Maybe ConfigurationId) Source #

The ID of the updated configuration.

updateBrokerResponse_engineVersion :: Lens' UpdateBrokerResponse (Maybe Text) Source #

The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

updateBrokerResponse_hostInstanceType :: Lens' UpdateBrokerResponse (Maybe Text) Source #

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

updateBrokerResponse_ldapServerMetadata :: Lens' UpdateBrokerResponse (Maybe LdapServerMetadataOutput) Source #

Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

updateBrokerResponse_logs :: Lens' UpdateBrokerResponse (Maybe Logs) Source #

The list of information about logs to be enabled for the specified broker.

updateBrokerResponse_maintenanceWindowStartTime :: Lens' UpdateBrokerResponse (Maybe WeeklyStartTime) Source #

The parameters that determine the WeeklyStartTime.

updateBrokerResponse_securityGroups :: Lens' UpdateBrokerResponse (Maybe [Text]) Source #

The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.

updateBrokerResponse_httpStatus :: Lens' UpdateBrokerResponse Int Source #

The response's http status code.