This product is not supported for your selected
Datadog site. (
).
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project,
feel free to reach out to us!aws_mq_broker
account_id
Type: STRING
actions_required
Type: UNORDERED_LIST_STRUCT
Provider name: ActionsRequired
Description: Actions required for a broker.
action_required_code
Type: STRING
Provider name: ActionRequiredCode
Description: The code you can use to find instructions on the action required to resolve your broker issue.
action_required_info
Type: STRING
Provider name: ActionRequiredInfo
Description: Information about the action required to resolve your broker issue.
authentication_strategy
Type: STRING
Provider name: AuthenticationStrategy
Description: The authentication strategy used to secure the broker. The default is SIMPLE.
auto_minor_version_upgrade
Type: BOOLEAN
Provider name: AutoMinorVersionUpgrade
Description: Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
broker_arn
Type: STRING
Provider name: BrokerArn
Description: The broker’s Amazon Resource Name (ARN).
broker_id
Type: STRING
Provider name: BrokerId
Description: The unique ID that Amazon MQ generates for the broker.
broker_instances
Type: UNORDERED_LIST_STRUCT
Provider name: BrokerInstances
Description: A list of information about allocated brokers.
console_url
Type: STRING
Provider name: ConsoleURL
Description: The brokers web console URL.
endpoints
Type: UNORDERED_LIST_STRING
Provider name: Endpoints
Description: The broker’s wire-level protocol endpoints.
ip_address
Type: STRING
Provider name: IpAddress
Description: The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.
broker_name
Type: STRING
Provider name: BrokerName
Description: The broker’s name. This value must be unique in your Amazon Web Services account 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.
broker_state
Type: STRING
Provider name: BrokerState
Description: The broker’s status.
configurations
Type: STRUCT
Provider name: Configurations
Description: The list of all revisions for the specified configuration.
current
Type: STRUCT
Provider name: Current
Description: The broker’s current configuration.
id
Type: STRING
Provider name: Id
Description: Required. The unique ID that Amazon MQ generates for the configuration.
revision
Type: INT32
Provider name: Revision
Description: The revision number of the configuration.
pending
Type: STRUCT
Provider name: Pending
Description: The broker’s pending configuration.
id
Type: STRING
Provider name: Id
Description: Required. The unique ID that Amazon MQ generates for the configuration.
revision
Type: INT32
Provider name: Revision
Description: The revision number of the configuration.
created
Type: TIMESTAMP
Provider name: Created
Description: The time when the broker was created.
Type: STRUCT
Provider name: DataReplicationMetadata
Description: The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.
data_replication_counterpart
Type: STRUCT
Provider name: DataReplicationCounterpart
Description: Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker’s dataReplicationRole property.
broker_id
Type: STRING
Provider name: BrokerId
Description: Required. The unique broker id generated by Amazon MQ.
region
Type: STRING
Provider name: Region
Description: Required. The region of the broker.
data_replication_role
Type: STRING
Provider name: DataReplicationRole
Description: Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.
data_replication_mode
Type: STRING
Provider name: DataReplicationMode
Description: Describes whether this broker is a part of a data replication pair.
deployment_mode
Type: STRING
Provider name: DeploymentMode
Description: The broker’s deployment mode.
encryption_options
Type: STRUCT
Provider name: EncryptionOptions
Description: Encryption options for the broker.
kms_key_id
Type: STRING
Provider name: KmsKeyId
Description: The customer master key (CMK) to use for the A KMS (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.
use_aws_owned_key
Type: BOOLEAN
Provider name: UseAwsOwnedKey
Description: Enables the use of an Amazon Web Services owned CMK using KMS (KMS). Set to true by default, if no value is provided, for example, for RabbitMQ brokers.
engine_type
Type: STRING
Provider name: EngineType
Description: The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version
Type: STRING
Provider name: EngineVersion
Description: The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
host_instance_type
Type: STRING
Provider name: HostInstanceType
Description: The broker’s instance type.
Type: STRUCT
Provider name: LdapServerMetadata
Description: The metadata of the LDAP server used to authenticate and authorize connections to the broker.
hosts
Type: UNORDERED_LIST_STRING
Provider name: Hosts
Description: Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
role_base
Type: STRING
Provider name: RoleBase
Description: 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.
role_name
Type: STRING
Provider name: RoleName
Description: Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
role_search_matching
Type: STRING
Provider name: RoleSearchMatching
Description: 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.
role_search_subtree
Type: BOOLEAN
Provider name: RoleSearchSubtree
Description: The directory search scope for the role. If set to true, scope is to search the entire subtree.
service_account_username
Type: STRING
Provider name: ServiceAccountUsername
Description: 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.
user_base
Type: STRING
Provider name: UserBase
Description: 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.
user_role_name
Type: STRING
Provider name: UserRoleName
Description: Specifies the name of the LDAP attribute for the user group membership.
user_search_matching
Type: STRING
Provider name: UserSearchMatching
Description: 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.
user_search_subtree
Type: BOOLEAN
Provider name: UserSearchSubtree
Description: The directory search scope for the user. If set to true, scope is to search the entire subtree.
logs
Type: STRUCT
Provider name: Logs
Description: The list of information about logs currently enabled and pending to be deployed for the specified broker.
audit
Type: BOOLEAN
Provider name: Audit
Description: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
audit_log_group
Type: STRING
Provider name: AuditLogGroup
Description: The location of the CloudWatch Logs log group where audit logs are sent.
general
Type: BOOLEAN
Provider name: General
Description: Enables general logging.
general_log_group
Type: STRING
Provider name: GeneralLogGroup
Description: The location of the CloudWatch Logs log group where general logs are sent.
pending
Type: STRUCT
Provider name: Pending
Description: The list of information about logs pending to be deployed for the specified broker.
audit
Type: BOOLEAN
Provider name: Audit
Description: Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.
general
Type: BOOLEAN
Provider name: General
Description: Enables general logging.
maintenance_window_start_time
Type: STRUCT
Provider name: MaintenanceWindowStartTime
Description: The parameters that determine the WeeklyStartTime.
day_of_week
Type: STRING
Provider name: DayOfWeek
Description: Required. The day of the week.
time_of_day
Type: STRING
Provider name: TimeOfDay
Description: Required. The time, in 24-hour format.
time_zone
Type: STRING
Provider name: TimeZone
Description: The time zone, UTC by default, in either the Country/City format, or the UTC offset format.
pending_authentication_strategy
Type: STRING
Provider name: PendingAuthenticationStrategy
Description: The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
Type: STRUCT
Provider name: PendingDataReplicationMetadata
Description: The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.
data_replication_counterpart
Type: STRUCT
Provider name: DataReplicationCounterpart
Description: Describes the replica/primary broker. Only returned if this broker is currently set as a primary or replica in the broker’s dataReplicationRole property.
broker_id
Type: STRING
Provider name: BrokerId
Description: Required. The unique broker id generated by Amazon MQ.
region
Type: STRING
Provider name: Region
Description: Required. The region of the broker.
data_replication_role
Type: STRING
Provider name: DataReplicationRole
Description: Defines the role of this broker in a data replication pair. When a replica broker is promoted to primary, this role is interchanged.
pending_data_replication_mode
Type: STRING
Provider name: PendingDataReplicationMode
Description: Describes whether this broker will be a part of a data replication pair after reboot.
pending_engine_version
Type: STRING
Provider name: PendingEngineVersion
Description: The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
pending_host_instance_type
Type: STRING
Provider name: PendingHostInstanceType
Description: The broker’s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
Type: STRUCT
Provider name: PendingLdapServerMetadata
Description: The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
hosts
Type: UNORDERED_LIST_STRING
Provider name: Hosts
Description: Specifies the location of the LDAP server such as Directory Service for Microsoft Active Directory. Optional failover server.
role_base
Type: STRING
Provider name: RoleBase
Description: 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.
role_name
Type: STRING
Provider name: RoleName
Description: Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query.
role_search_matching
Type: STRING
Provider name: RoleSearchMatching
Description: 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.
role_search_subtree
Type: BOOLEAN
Provider name: RoleSearchSubtree
Description: The directory search scope for the role. If set to true, scope is to search the entire subtree.
service_account_username
Type: STRING
Provider name: ServiceAccountUsername
Description: 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.
user_base
Type: STRING
Provider name: UserBase
Description: 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.
user_role_name
Type: STRING
Provider name: UserRoleName
Description: Specifies the name of the LDAP attribute for the user group membership.
user_search_matching
Type: STRING
Provider name: UserSearchMatching
Description: 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.
user_search_subtree
Type: BOOLEAN
Provider name: UserSearchSubtree
Description: The directory search scope for the user. If set to true, scope is to search the entire subtree.
pending_security_groups
Type: UNORDERED_LIST_STRING
Provider name: PendingSecurityGroups
Description: The list of pending security groups to authorize connections to brokers.
publicly_accessible
Type: BOOLEAN
Provider name: PubliclyAccessible
Description: Enables connections from applications outside of the VPC that hosts the broker’s subnets.
security_groups
Type: UNORDERED_LIST_STRING
Provider name: SecurityGroups
Description: The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storage_type
Type: STRING
Provider name: StorageType
Description: The broker’s storage type.
subnet_ids
Type: UNORDERED_LIST_STRING
Provider name: SubnetIds
Description: The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
Type: UNORDERED_LIST_STRING
