BrokerState class

Input properties used for looking up and filtering Broker resources.

Constructors

BrokerState({Input<bool?>? applyImmediately, Input<String?>? arn, Input<String?>? authenticationStrategy, Input<bool?>? autoMinorVersionUpgrade, Input<String?>? brokerName, Input<BrokerConfiguration?>? configuration, Input<String?>? dataReplicationMode, Input<String?>? dataReplicationPrimaryBrokerArn, Input<String?>? deploymentMode, Input<BrokerEncryptionOptions?>? encryptionOptions, Input<String?>? engineType, Input<String?>? engineVersion, Input<String?>? hostInstanceType, Input<List<BrokerInstance>?>? instances, Input<BrokerLdapServerMetadata?>? ldapServerMetadata, Input<BrokerLogs?>? logs, Input<BrokerMaintenanceWindowStartTime?>? maintenanceWindowStartTime, Input<String?>? pendingDataReplicationMode, Input<bool?>? publiclyAccessible, Input<String?>? region, Input<List<String>?>? resourceShareArns, Input<List<String>?>? securityGroups, Input<List<BrokerSharedResource>?>? sharedResources, Input<String?>? storageType, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<List<BrokerUser>?>? users})
Creates a new BrokerState. applyImmediately Whether to apply broker modifications immediately. Default is false. arn ARN of the broker. authenticationStrategy Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engineType RabbitMQ. autoMinorVersionUpgrade Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available. brokerName Name of the broker. configuration Configuration block for broker configuration. Applies to engineType of ActiveMQ and RabbitMQ only. Detailed below. dataReplicationMode Whether this broker is part of a data replication pair. Valid values are CRDR and NONE. dataReplicationPrimaryBrokerArn ARN of the primary broker used to replicate data in a data replication pair. Required when dataReplicationMode is CRDR. deploymentMode Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE. encryptionOptions Configuration block containing encryption options. Detailed below. engineType Type of broker engine. Valid values are ActiveMQ and RabbitMQ. engineVersion Version of the broker engine. hostInstanceType Broker's instance type. For example, mq.t3.micro, mq.m5.large. instances List of information about allocated brokers (both active & standby). ldapServerMetadata Configuration block for the LDAP server used to authenticate and authorize connections. Not supported for engineType RabbitMQ. Detailed below. logs Configuration block for the logging configuration. Detailed below. maintenanceWindowStartTime Configuration block for the maintenance window start time. Detailed below. pendingDataReplicationMode Data replication mode that will be applied after reboot. publiclyAccessible Whether to enable connections from applications outside of the VPC that hosts the broker's subnets. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. resourceShareArns Set of AWS RAM resource share ARNs that grant the broker access to shared resources for private networking. Applies to engineType of RabbitMQ only. Because Amazon MQ applies resource shares during a reboot, set applyImmediately to true for changes to take effect without waiting for the next maintenance window. securityGroups List of security group IDs assigned to the broker. sharedResources List of resources shared with the broker via resourceShareArns. Only populated for engineType of RabbitMQ. storageType Storage type of the broker. For engineType ActiveMQ, valid values are efs and ebs (AWS-default is efs). For engineType RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported. subnetIds List of subnet IDs in which to launch the broker. A SINGLE_INSTANCE deployment requires one subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires multiple subnets. tags Map of tags to assign to the broker. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. users Configuration block for broker users. For engineType of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
const
BrokerState.fromMap(Map<String, dynamic> map)
factory

Properties

applyImmediately → Input<bool?>?
Whether to apply broker modifications immediately. Default is false.
final
arn → Input<String?>?
ARN of the broker.
final
authenticationStrategy → Input<String?>?
Authentication strategy used to secure the broker. Valid values are simple and ldap. ldap is not supported for engineType RabbitMQ.
final
autoMinorVersionUpgrade → Input<bool?>?
Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
final
brokerName → Input<String?>?
Name of the broker.
final
configuration → Input<BrokerConfiguration?>?
Configuration block for broker configuration. Applies to engineType of ActiveMQ and RabbitMQ only. Detailed below.
final
dataReplicationMode → Input<String?>?
Whether this broker is part of a data replication pair. Valid values are CRDR and NONE.
final
dataReplicationPrimaryBrokerArn → Input<String?>?
ARN of the primary broker used to replicate data in a data replication pair. Required when dataReplicationMode is CRDR.
final
deploymentMode → Input<String?>?
Deployment mode of the broker. Valid values are SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_MULTI_AZ. Default is SINGLE_INSTANCE.
final
encryptionOptions → Input<BrokerEncryptionOptions?>?
Configuration block containing encryption options. Detailed below.
final
engineType → Input<String?>?
Type of broker engine. Valid values are ActiveMQ and RabbitMQ.
final
engineVersion → Input<String?>?
Version of the broker engine.
final
hashCode → int
The hash code for this object.
no setterinherited
hostInstanceType → Input<String?>?
Broker's instance type. For example, mq.t3.micro, mq.m5.large.
final
instances → Input<List<BrokerInstance>?>?
List of information about allocated brokers (both active & standby).
final
ldapServerMetadata → Input<BrokerLdapServerMetadata?>?
Configuration block for the LDAP server used to authenticate and authorize connections. Not supported for engineType RabbitMQ. Detailed below.
final
logs → Input<BrokerLogs?>?
Configuration block for the logging configuration. Detailed below.
final
maintenanceWindowStartTime → Input<BrokerMaintenanceWindowStartTime?>?
Configuration block for the maintenance window start time. Detailed below.
final
pendingDataReplicationMode → Input<String?>?
Data replication mode that will be applied after reboot.
final
publiclyAccessible → Input<bool?>?
Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
resourceShareArns → Input<List<String>?>?
Set of AWS RAM resource share ARNs that grant the broker access to shared resources for private networking. Applies to engineType of RabbitMQ only. Because Amazon MQ applies resource shares during a reboot, set applyImmediately to true for changes to take effect without waiting for the next maintenance window.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroups → Input<List<String>?>?
List of security group IDs assigned to the broker.
final
sharedResources → Input<List<BrokerSharedResource>?>?
List of resources shared with the broker via resourceShareArns. Only populated for engineType of RabbitMQ.
final
storageType → Input<String?>?
Storage type of the broker. For engineType ActiveMQ, valid values are efs and ebs (AWS-default is efs). For engineType RabbitMQ, only ebs is supported. When using ebs, only the mq.m5 broker instance type family is supported.
final
subnetIds → Input<List<String>?>?
List of subnet IDs in which to launch the broker. A SINGLE_INSTANCE deployment requires one subnet. An ACTIVE_STANDBY_MULTI_AZ deployment requires multiple subnets.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the broker. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
users → Input<List<BrokerUser>?>?
Configuration block for broker users. For engineType of RabbitMQ, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited