Package com.pulumi.aws.mq
Class BrokerArgs
- java.lang.Object
-
- com.pulumi.resources.InputArgs
-
- com.pulumi.resources.ResourceArgs
-
- com.pulumi.aws.mq.BrokerArgs
-
public final class BrokerArgs extends com.pulumi.resources.ResourceArgs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBrokerArgs.Builder
-
Field Summary
Fields Modifier and Type Field Description static BrokerArgsEmpty
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>applyImmediately()java.util.Optional<com.pulumi.core.Output<java.lang.String>>authenticationStrategy()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>autoMinorVersionUpgrade()java.util.Optional<com.pulumi.core.Output<java.lang.String>>brokerName()static BrokerArgs.Builderbuilder()static BrokerArgs.Builderbuilder(BrokerArgs defaults)java.util.Optional<com.pulumi.core.Output<BrokerConfigurationArgs>>configuration()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dataReplicationMode()java.util.Optional<com.pulumi.core.Output<java.lang.String>>dataReplicationPrimaryBrokerArn()java.util.Optional<com.pulumi.core.Output<java.lang.String>>deploymentMode()java.util.Optional<com.pulumi.core.Output<BrokerEncryptionOptionsArgs>>encryptionOptions()com.pulumi.core.Output<java.lang.String>engineType()com.pulumi.core.Output<java.lang.String>engineVersion()com.pulumi.core.Output<java.lang.String>hostInstanceType()java.util.Optional<com.pulumi.core.Output<BrokerLdapServerMetadataArgs>>ldapServerMetadata()java.util.Optional<com.pulumi.core.Output<BrokerLogsArgs>>logs()java.util.Optional<com.pulumi.core.Output<BrokerMaintenanceWindowStartTimeArgs>>maintenanceWindowStartTime()java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>publiclyAccessible()java.util.Optional<com.pulumi.core.Output<java.lang.String>>region()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>resourceShareArns()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>securityGroups()java.util.Optional<com.pulumi.core.Output<java.lang.String>>storageType()java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>subnetIds()java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>>tags()java.util.Optional<com.pulumi.core.Output<java.util.List<BrokerUserArgs>>>users()
-
-
-
Field Detail
-
Empty
public static final BrokerArgs Empty
-
-
Method Detail
-
applyImmediately
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
- Returns:
- Whether to apply broker modifications immediately. Default is `false`.
-
authenticationStrategy
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authenticationStrategy()
- Returns:
- Authentication strategy used to secure the broker. Valid values are `simple` and `ldap`. `ldap` is not supported for `engineType` `RabbitMQ`.
-
autoMinorVersionUpgrade
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> autoMinorVersionUpgrade()
- Returns:
- Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available.
-
brokerName
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> brokerName()
- Returns:
- Name of the broker.
-
configuration
public java.util.Optional<com.pulumi.core.Output<BrokerConfigurationArgs>> configuration()
- Returns:
- Configuration block for broker configuration. Applies to `engineType` of `ActiveMQ` and `RabbitMQ` only. Detailed below.
-
dataReplicationMode
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataReplicationMode()
- Returns:
- Whether this broker is part of a data replication pair. Valid values are `CRDR` and `NONE`.
-
dataReplicationPrimaryBrokerArn
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dataReplicationPrimaryBrokerArn()
- Returns:
- ARN of the primary broker used to replicate data in a data replication pair. Required when `dataReplicationMode` is `CRDR`.
-
deploymentMode
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> deploymentMode()
- Returns:
- Deployment mode of the broker. Valid values are `SINGLE_INSTANCE`, `ACTIVE_STANDBY_MULTI_AZ`, and `CLUSTER_MULTI_AZ`. Default is `SINGLE_INSTANCE`.
-
encryptionOptions
public java.util.Optional<com.pulumi.core.Output<BrokerEncryptionOptionsArgs>> encryptionOptions()
- Returns:
- Configuration block containing encryption options. Detailed below.
-
engineType
public com.pulumi.core.Output<java.lang.String> engineType()
- Returns:
- Type of broker engine. Valid values are `ActiveMQ` and `RabbitMQ`.
-
engineVersion
public com.pulumi.core.Output<java.lang.String> engineVersion()
- Returns:
- Version of the broker engine.
-
hostInstanceType
public com.pulumi.core.Output<java.lang.String> hostInstanceType()
- Returns:
- Broker's instance type. For example, `mq.t3.micro`, `mq.m5.large`. The following arguments are optional:
-
ldapServerMetadata
public java.util.Optional<com.pulumi.core.Output<BrokerLdapServerMetadataArgs>> ldapServerMetadata()
- Returns:
- Configuration block for the LDAP server used to authenticate and authorize connections. Not supported for `engineType` `RabbitMQ`. Detailed below.
-
logs
public java.util.Optional<com.pulumi.core.Output<BrokerLogsArgs>> logs()
- Returns:
- Configuration block for the logging configuration. Detailed below.
-
maintenanceWindowStartTime
public java.util.Optional<com.pulumi.core.Output<BrokerMaintenanceWindowStartTimeArgs>> maintenanceWindowStartTime()
- Returns:
- Configuration block for the maintenance window start time. Detailed below.
-
publiclyAccessible
public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
- Returns:
- Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.
-
region
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
resourceShareArns
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> resourceShareArns()
- Returns:
- Set of [AWS RAM](https://docs.aws.amazon.com/ram/latest/userguide/what-is.html) resource share ARNs that grant the broker access to shared resources for [private networking](https://aws.amazon.com/blogs/big-data/introducing-private-networking-for-amazon-mq-for-rabbitmq/). 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
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroups()
- Returns:
- List of security group IDs assigned to the broker.
-
storageType
public java.util.Optional<com.pulumi.core.Output<java.lang.String>> storageType()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> subnetIds()
- Returns:
- 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
public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- 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.
-
users
public java.util.Optional<com.pulumi.core.Output<java.util.List<BrokerUserArgs>>> users()
- Returns:
- 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.
-
builder
public static BrokerArgs.Builder builder()
-
builder
public static BrokerArgs.Builder builder(BrokerArgs defaults)
-
-