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< ? instances, Input<BrokerInstance> ?>BrokerLdapServerMetadata?> ? ldapServerMetadata, Input<BrokerLogs?> ? logs, Input<BrokerMaintenanceWindowStartTime?> ? maintenanceWindowStartTime, Input<String?> ? pendingDataReplicationMode, Input<bool?> ? publiclyAccessible, Input<String?> ? region, Input<List< ? securityGroups, Input<String> ?>String?> ? storageType, Input<List< ? subnetIds, Input<String> ?>Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>List< ? users})BrokerUser> ?> -
Creates a new BrokerState.
applyImmediatelyWhether to apply broker modifications immediately. Default isfalse.arnARN of the broker.authenticationStrategyAuthentication strategy used to secure the broker. Valid values aresimpleandldap.ldapis not supported forengineTypeRabbitMQ.autoMinorVersionUpgradeWhether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.brokerNameName of the broker.configurationConfiguration block for broker configuration. Applies toengineTypeofActiveMQandRabbitMQonly. Detailed below.dataReplicationModeWhether this broker is part of a data replication pair. Valid values areCRDRandNONE.dataReplicationPrimaryBrokerArnARN of the primary broker used to replicate data in a data replication pair. Required whendataReplicationModeisCRDR.deploymentModeDeployment mode of the broker. Valid values areSINGLE_INSTANCE,ACTIVE_STANDBY_MULTI_AZ, andCLUSTER_MULTI_AZ. Default isSINGLE_INSTANCE.encryptionOptionsConfiguration block containing encryption options. Detailed below.engineTypeType of broker engine. Valid values areActiveMQandRabbitMQ.engineVersionVersion of the broker engine.hostInstanceTypeBroker's instance type. For example,mq.t3.micro,mq.m5.large.instancesList of information about allocated brokers (both active & standby).ldapServerMetadataConfiguration block for the LDAP server used to authenticate and authorize connections. Not supported forengineTypeRabbitMQ. Detailed below.logsConfiguration block for the logging configuration. Detailed below.maintenanceWindowStartTimeConfiguration block for the maintenance window start time. Detailed below.pendingDataReplicationModeData replication mode that will be applied after reboot.publiclyAccessibleWhether to enable connections from applications outside of the VPC that hosts the broker's subnets.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.resourceShareArnsSet of AWS RAM resource share ARNs that grant the broker access to shared resources for private networking. Applies toengineTypeofRabbitMQonly. Because Amazon MQ applies resource shares during a reboot, setapplyImmediatelytotruefor changes to take effect without waiting for the next maintenance window.securityGroupsList of security group IDs assigned to the broker.sharedResourcesList of resources shared with the broker viaresourceShareArns. Only populated forengineTypeofRabbitMQ.storageTypeStorage type of the broker. ForengineTypeActiveMQ, valid values areefsandebs(AWS-default isefs). ForengineTypeRabbitMQ, onlyebsis supported. When usingebs, only themq.m5broker instance type family is supported.subnetIdsList of subnet IDs in which to launch the broker. ASINGLE_INSTANCEdeployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZdeployment requires multiple subnets.tagsMap of tags to assign to the broker. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.usersConfiguration block for broker users. ForengineTypeofRabbitMQ, 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
simpleandldap.ldapis not supported forengineTypeRabbitMQ.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
engineTypeofActiveMQandRabbitMQonly. Detailed below.final -
dataReplicationMode
→ Input<
String?> ? -
Whether this broker is part of a data replication pair. Valid values are
CRDRandNONE.final -
dataReplicationPrimaryBrokerArn
→ Input<
String?> ? -
ARN of the primary broker used to replicate data in a data replication pair. Required when
dataReplicationModeisCRDR.final -
deploymentMode
→ Input<
String?> ? -
Deployment mode of the broker. Valid values are
SINGLE_INSTANCE,ACTIVE_STANDBY_MULTI_AZ, andCLUSTER_MULTI_AZ. Default isSINGLE_INSTANCE.final -
encryptionOptions
→ Input<
BrokerEncryptionOptions?> ? -
Configuration block containing encryption options. Detailed below.
final
-
engineType
→ Input<
String?> ? -
Type of broker engine. Valid values are
ActiveMQandRabbitMQ.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
engineTypeRabbitMQ. 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
-
Set of AWS RAM resource share ARNs that grant the broker access to shared resources for private networking. Applies to
engineTypeofRabbitMQonly. Because Amazon MQ applies resource shares during a reboot, setapplyImmediatelytotruefor 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
-
List of resources shared with the broker via
resourceShareArns. Only populated forengineTypeofRabbitMQ.final -
storageType
→ Input<
String?> ? -
Storage type of the broker. For
engineTypeActiveMQ, valid values areefsandebs(AWS-default isefs). ForengineTypeRabbitMQ, onlyebsis supported. When usingebs, only themq.m5broker instance type family is supported.final -
subnetIds
→ Input<
List< ?String> ?> -
List of subnet IDs in which to launch the broker. A
SINGLE_INSTANCEdeployment requires one subnet. AnACTIVE_STANDBY_MULTI_AZdeployment requires multiple subnets.final -
Map of tags to assign to the broker. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
users
→ Input<
List< ?BrokerUser> ?> -
Configuration block for broker users. For
engineTypeofRabbitMQ, 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