amazonka-mq-2.0: Amazon MQ SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MQ.Lens

Description

 
Synopsis

Operations

CreateBroker

createBroker_authenticationStrategy :: Lens' CreateBroker (Maybe AuthenticationStrategy) Source #

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

createBroker_configuration :: Lens' CreateBroker (Maybe ConfigurationId) Source #

A list of information about the configuration.

createBroker_creatorRequestId :: Lens' CreateBroker (Maybe Text) Source #

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

createBroker_encryptionOptions :: Lens' CreateBroker (Maybe EncryptionOptions) Source #

Encryption options for the broker. Does not apply to RabbitMQ brokers.

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

createBroker_logs :: Lens' CreateBroker (Maybe Logs) Source #

Enables Amazon CloudWatch logging for brokers.

createBroker_maintenanceWindowStartTime :: Lens' CreateBroker (Maybe WeeklyStartTime) Source #

The parameters that determine the WeeklyStartTime.

createBroker_securityGroups :: Lens' CreateBroker (Maybe [Text]) Source #

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

createBroker_subnetIds :: Lens' CreateBroker (Maybe [Text]) Source #

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_tags :: Lens' CreateBroker (Maybe (HashMap Text Text)) Source #

Create tags when creating the broker.

createBroker_engineVersion :: Lens' CreateBroker Text Source #

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

createBroker_hostInstanceType :: Lens' CreateBroker Text Source #

Required. The broker's instance type.

createBroker_autoMinorVersionUpgrade :: Lens' CreateBroker 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. Set to true by default, if no value is specified.

createBroker_users :: Lens' CreateBroker [User] Source #

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_brokerName :: Lens' CreateBroker Text Source #

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_deploymentMode :: Lens' CreateBroker DeploymentMode Source #

Required. The broker's deployment mode.

createBroker_engineType :: Lens' CreateBroker EngineType Source #

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

createBroker_publiclyAccessible :: Lens' CreateBroker Bool Source #

Enables connections from applications outside of the VPC that hosts the broker's subnets. Set to false by default, if no value is provided.

createBrokerResponse_brokerArn :: Lens' CreateBrokerResponse (Maybe Text) Source #

The broker's Amazon Resource Name (ARN).

createBrokerResponse_brokerId :: Lens' CreateBrokerResponse (Maybe Text) Source #

The unique ID that Amazon MQ generates for the broker.

CreateConfiguration

createConfiguration_authenticationStrategy :: Lens' CreateConfiguration (Maybe AuthenticationStrategy) Source #

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

createConfiguration_tags :: Lens' CreateConfiguration (Maybe (HashMap Text Text)) Source #

Create tags when creating the configuration.

createConfiguration_engineVersion :: Lens' CreateConfiguration Text Source #

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

createConfiguration_engineType :: Lens' CreateConfiguration EngineType Source #

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

createConfiguration_name :: Lens' CreateConfiguration 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.

createConfigurationResponse_arn :: Lens' CreateConfigurationResponse (Maybe Text) Source #

Required. The Amazon Resource Name (ARN) of the configuration.

createConfigurationResponse_authenticationStrategy :: Lens' CreateConfigurationResponse (Maybe AuthenticationStrategy) Source #

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

createConfigurationResponse_created :: Lens' CreateConfigurationResponse (Maybe UTCTime) Source #

Required. The date and time of the configuration.

createConfigurationResponse_id :: Lens' CreateConfigurationResponse (Maybe Text) Source #

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

createConfigurationResponse_name :: Lens' CreateConfigurationResponse (Maybe 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.

CreateTags

createTags_tags :: Lens' CreateTags (Maybe (HashMap Text Text)) Source #

The key-value pair for the resource tag.

createTags_resourceArn :: Lens' CreateTags Text Source #

The Amazon Resource Name (ARN) of the resource tag.

CreateUser

createUser_consoleAccess :: Lens' CreateUser (Maybe Bool) Source #

Enables access to the ActiveMQ Web Console for the ActiveMQ user.

createUser_groups :: Lens' CreateUser (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.

createUser_username :: Lens' CreateUser Text Source #

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_brokerId :: Lens' CreateUser Text Source #

The unique ID that Amazon MQ generates for the broker.

createUser_password :: Lens' CreateUser 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 (,:=).

DeleteBroker

deleteBroker_brokerId :: Lens' DeleteBroker Text Source #

The unique ID that Amazon MQ generates for the broker.

deleteBrokerResponse_brokerId :: Lens' DeleteBrokerResponse (Maybe Text) Source #

The unique ID that Amazon MQ generates for the broker.

DeleteTags

deleteTags_tagKeys :: Lens' DeleteTags [Text] Source #

An array of tag keys to delete

deleteTags_resourceArn :: Lens' DeleteTags Text Source #

The Amazon Resource Name (ARN) of the resource tag.

DeleteUser

deleteUser_username :: Lens' DeleteUser Text Source #

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_brokerId :: Lens' DeleteUser Text Source #

The unique ID that Amazon MQ generates for the broker.

DescribeBroker

describeBroker_brokerId :: Lens' DescribeBroker Text Source #

The unique ID that Amazon MQ generates for the broker.

describeBrokerResponse_authenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #

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

describeBrokerResponse_autoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (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.

describeBrokerResponse_brokerArn :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's Amazon Resource Name (ARN).

describeBrokerResponse_brokerId :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The unique ID that Amazon MQ generates for the broker.

describeBrokerResponse_brokerName :: Lens' DescribeBrokerResponse (Maybe Text) Source #

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_configurations :: Lens' DescribeBrokerResponse (Maybe Configurations) Source #

The list of all revisions for the specified configuration.

describeBrokerResponse_encryptionOptions :: Lens' DescribeBrokerResponse (Maybe EncryptionOptions) Source #

Encryption options for the broker. Does not apply to RabbitMQ brokers.

describeBrokerResponse_engineType :: Lens' DescribeBrokerResponse (Maybe EngineType) Source #

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

describeBrokerResponse_engineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #

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

describeBrokerResponse_ldapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

describeBrokerResponse_logs :: Lens' DescribeBrokerResponse (Maybe LogsSummary) Source #

The list of information about logs currently enabled and pending to be deployed for the specified broker.

describeBrokerResponse_pendingAuthenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

describeBrokerResponse_pendingEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #

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

describeBrokerResponse_pendingHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #

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

describeBrokerResponse_pendingLdapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

describeBrokerResponse_pendingSecurityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of pending security groups to authorize connections to brokers.

describeBrokerResponse_publiclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool) Source #

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

describeBrokerResponse_securityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

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

describeBrokerResponse_subnetIds :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

describeBrokerResponse_tags :: Lens' DescribeBrokerResponse (Maybe (HashMap Text Text)) Source #

The list of all tags associated with this broker.

describeBrokerResponse_users :: Lens' DescribeBrokerResponse (Maybe [UserSummary]) Source #

The list of all broker usernames for the specified broker.

DescribeBrokerEngineTypes

describeBrokerEngineTypes_maxResults :: Lens' DescribeBrokerEngineTypes (Maybe Natural) Source #

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_nextToken :: Lens' DescribeBrokerEngineTypes (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

describeBrokerEngineTypesResponse_maxResults :: Lens' DescribeBrokerEngineTypesResponse (Maybe Natural) Source #

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.

describeBrokerEngineTypesResponse_nextToken :: Lens' DescribeBrokerEngineTypesResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

DescribeBrokerInstanceOptions

describeBrokerInstanceOptions_maxResults :: Lens' DescribeBrokerInstanceOptions (Maybe Natural) Source #

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_nextToken :: Lens' DescribeBrokerInstanceOptions (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

describeBrokerInstanceOptionsResponse_maxResults :: Lens' DescribeBrokerInstanceOptionsResponse (Maybe Natural) Source #

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.

describeBrokerInstanceOptionsResponse_nextToken :: Lens' DescribeBrokerInstanceOptionsResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

DescribeConfiguration

describeConfiguration_configurationId :: Lens' DescribeConfiguration Text Source #

The unique ID that Amazon MQ generates for the configuration.

describeConfigurationResponse_authenticationStrategy :: Lens' DescribeConfigurationResponse (Maybe AuthenticationStrategy) Source #

Optional. The authentication strategy associated with the configuration. The default is SIMPLE.

describeConfigurationResponse_created :: Lens' DescribeConfigurationResponse (Maybe UTCTime) Source #

Required. The date and time of the configuration revision.

describeConfigurationResponse_engineType :: Lens' DescribeConfigurationResponse (Maybe EngineType) Source #

Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

describeConfigurationResponse_engineVersion :: Lens' DescribeConfigurationResponse (Maybe Text) Source #

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

describeConfigurationResponse_id :: Lens' DescribeConfigurationResponse (Maybe Text) Source #

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

describeConfigurationResponse_name :: Lens' DescribeConfigurationResponse (Maybe 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.

describeConfigurationResponse_tags :: Lens' DescribeConfigurationResponse (Maybe (HashMap Text Text)) Source #

The list of all tags associated with this configuration.

DescribeConfigurationRevision

describeConfigurationRevision_configurationId :: Lens' DescribeConfigurationRevision Text Source #

The unique ID that Amazon MQ generates for the configuration.

describeConfigurationRevisionResponse_configurationId :: Lens' DescribeConfigurationRevisionResponse (Maybe Text) Source #

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

DescribeUser

describeUser_username :: Lens' DescribeUser Text Source #

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_brokerId :: Lens' DescribeUser Text Source #

The unique ID that Amazon MQ generates for the broker.

describeUserResponse_brokerId :: Lens' DescribeUserResponse (Maybe Text) Source #

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

describeUserResponse_consoleAccess :: Lens' DescribeUserResponse (Maybe Bool) Source #

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

describeUserResponse_groups :: Lens' DescribeUserResponse (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.

describeUserResponse_pending :: Lens' DescribeUserResponse (Maybe UserPendingChanges) Source #

The status of the changes pending for the ActiveMQ user.

describeUserResponse_username :: Lens' DescribeUserResponse (Maybe Text) Source #

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.

ListBrokers

listBrokers_maxResults :: Lens' ListBrokers (Maybe Natural) Source #

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_nextToken :: Lens' ListBrokers (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

listBrokersResponse_nextToken :: Lens' ListBrokersResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListConfigurationRevisions

listConfigurationRevisions_maxResults :: Lens' ListConfigurationRevisions (Maybe Natural) Source #

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_nextToken :: Lens' ListConfigurationRevisions (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

listConfigurationRevisions_configurationId :: Lens' ListConfigurationRevisions Text Source #

The unique ID that Amazon MQ generates for the configuration.

listConfigurationRevisionsResponse_configurationId :: Lens' ListConfigurationRevisionsResponse (Maybe Text) Source #

The unique ID that Amazon MQ generates for the configuration.

listConfigurationRevisionsResponse_maxResults :: Lens' ListConfigurationRevisionsResponse (Maybe Int) Source #

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.

listConfigurationRevisionsResponse_nextToken :: Lens' ListConfigurationRevisionsResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListConfigurations

listConfigurations_maxResults :: Lens' ListConfigurations (Maybe Natural) Source #

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_nextToken :: Lens' ListConfigurations (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

listConfigurationsResponse_configurations :: Lens' ListConfigurationsResponse (Maybe [Configuration]) Source #

The list of all revisions for the specified configuration.

listConfigurationsResponse_maxResults :: Lens' ListConfigurationsResponse (Maybe Int) Source #

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.

listConfigurationsResponse_nextToken :: Lens' ListConfigurationsResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

ListTags

listTags_resourceArn :: Lens' ListTags Text Source #

The Amazon Resource Name (ARN) of the resource tag.

listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (HashMap Text Text)) Source #

The key-value pair for the resource tag.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

ListUsers

listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #

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_nextToken :: Lens' ListUsers (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

listUsers_brokerId :: Lens' ListUsers Text Source #

The unique ID that Amazon MQ generates for the broker.

listUsersResponse_brokerId :: Lens' ListUsersResponse (Maybe Text) Source #

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

listUsersResponse_maxResults :: Lens' ListUsersResponse (Maybe Natural) Source #

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.

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.

listUsersResponse_users :: Lens' ListUsersResponse (Maybe [UserSummary]) Source #

Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

RebootBroker

rebootBroker_brokerId :: Lens' RebootBroker Text Source #

The unique ID that Amazon MQ generates for the broker.

UpdateBroker

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.

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_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_securityGroups :: Lens' UpdateBrokerResponse (Maybe [Text]) Source #

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

UpdateConfiguration

updateConfiguration_description :: Lens' UpdateConfiguration (Maybe Text) Source #

The description of the configuration.

updateConfiguration_configurationId :: Lens' UpdateConfiguration Text Source #

The unique ID that Amazon MQ generates for the configuration.

updateConfiguration_data :: Lens' UpdateConfiguration Text Source #

Required. The base64-encoded XML configuration.

updateConfigurationResponse_arn :: Lens' UpdateConfigurationResponse (Maybe Text) Source #

Required. The Amazon Resource Name (ARN) of the configuration.

updateConfigurationResponse_created :: Lens' UpdateConfigurationResponse (Maybe UTCTime) Source #

Required. The date and time of the configuration.

updateConfigurationResponse_id :: Lens' UpdateConfigurationResponse (Maybe Text) Source #

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

updateConfigurationResponse_name :: Lens' UpdateConfigurationResponse (Maybe 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.

updateConfigurationResponse_warnings :: Lens' UpdateConfigurationResponse (Maybe [SanitizationWarning]) Source #

The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.

UpdateUser

updateUser_consoleAccess :: Lens' UpdateUser (Maybe Bool) Source #

Enables access to the the ActiveMQ Web Console for the ActiveMQ user.

updateUser_groups :: Lens' UpdateUser (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.

updateUser_password :: Lens' UpdateUser (Maybe Text) Source #

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_username :: Lens' UpdateUser Text Source #

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_brokerId :: Lens' UpdateUser Text Source #

The unique ID that Amazon MQ generates for the broker.

Types

ActionRequired

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

availabilityZone_name :: Lens' AvailabilityZone (Maybe Text) Source #

Id for the availability zone.

BrokerEngineType

BrokerInstance

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

BrokerSummary

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_created :: Lens' BrokerSummary (Maybe UTCTime) Source #

The time when the broker was created.

Configuration

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

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

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

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

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

LdapServerMetadataInput

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

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

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.

logs_general :: Lens' Logs (Maybe Bool) Source #

Enables general logging.

LogsSummary

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

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

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

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

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

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

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.