Package software.amazon.awscdk.services.amazonmq

Interface CfnBrokerProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnBrokerProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.322Z") @Stability(Stable) public interface CfnBrokerProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnBroker.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amazonmq.*;
 CfnBrokerProps cfnBrokerProps = CfnBrokerProps.builder()
         .autoMinorVersionUpgrade(false)
         .brokerName("brokerName")
         .deploymentMode("deploymentMode")
         .engineType("engineType")
         .engineVersion("engineVersion")
         .hostInstanceType("hostInstanceType")
         .publiclyAccessible(false)
         .users(List.of(UserProperty.builder()
                 .password("password")
                 .username("username")
                 // the properties below are optional
                 .consoleAccess(false)
                 .groups(List.of("groups"))
                 .build()))
         // the properties below are optional
         .authenticationStrategy("authenticationStrategy")
         .configuration(ConfigurationIdProperty.builder()
                 .id("id")
                 .revision(123)
                 .build())
         .encryptionOptions(EncryptionOptionsProperty.builder()
                 .useAwsOwnedKey(false)
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build())
         .ldapServerMetadata(LdapServerMetadataProperty.builder()
                 .hosts(List.of("hosts"))
                 .roleBase("roleBase")
                 .roleSearchMatching("roleSearchMatching")
                 .serviceAccountPassword("serviceAccountPassword")
                 .serviceAccountUsername("serviceAccountUsername")
                 .userBase("userBase")
                 .userSearchMatching("userSearchMatching")
                 // the properties below are optional
                 .roleName("roleName")
                 .roleSearchSubtree(false)
                 .userRoleName("userRoleName")
                 .userSearchSubtree(false)
                 .build())
         .logs(LogListProperty.builder()
                 .audit(false)
                 .general(false)
                 .build())
         .maintenanceWindowStartTime(MaintenanceWindowProperty.builder()
                 .dayOfWeek("dayOfWeek")
                 .timeOfDay("timeOfDay")
                 .timeZone("timeZone")
                 .build())
         .securityGroups(List.of("securityGroups"))
         .storageType("storageType")
         .subnetIds(List.of("subnetIds"))
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @NotNull Object getAutoMinorVersionUpgrade()
      Enables automatic upgrades to new minor versions for brokers, as new broker engine 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.

    • getBrokerName

      @Stability(Stable) @NotNull String getBrokerName()
      The name of the broker.

      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.

      Do not add personally identifiable information (PII) or other confidential or sensitive information in broker names. Broker names are accessible to other AWS services, including C CloudWatch Logs . Broker names are not intended to be used for private or sensitive data.

    • getDeploymentMode

      @Stability(Stable) @NotNull String getDeploymentMode()
      The deployment mode of the broker. Available values:.

      • SINGLE_INSTANCE
      • ACTIVE_STANDBY_MULTI_AZ
      • CLUSTER_MULTI_AZ

    • getEngineType

      @Stability(Stable) @NotNull String getEngineType()
      The type of broker engine.

      Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ .

    • getEngineVersion

      @Stability(Stable) @NotNull String getEngineVersion()
      The version of the broker engine.

      For a list of supported engine versions, see Engine in the Amazon MQ Developer Guide .

    • getHostInstanceType

      @Stability(Stable) @NotNull String getHostInstanceType()
      The broker's instance type.

    • getPubliclyAccessible

      @Stability(Stable) @NotNull Object getPubliclyAccessible()
      Enables connections from applications outside of the VPC that hosts the broker's subnets.

    • getUsers

      @Stability(Stable) @NotNull Object getUsers()
      The list of broker users (persons or applications) who can access queues and topics.

      For Amazon MQ for RabbitMQ brokers, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent RabbitMQ users are created by via the RabbitMQ web console or by using the RabbitMQ management API.

    • getAuthenticationStrategy

      @Stability(Stable) @Nullable default String getAuthenticationStrategy()
      Optional.

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

    • getConfiguration

      @Stability(Stable) @Nullable default Object getConfiguration()
      A list of information about the configuration.

      Does not apply to RabbitMQ brokers.

    • getEncryptionOptions

      @Stability(Stable) @Nullable default Object getEncryptionOptions()
      Encryption options for the broker.

      Does not apply to RabbitMQ brokers.

    • getLdapServerMetadata

      @Stability(Stable) @Nullable default Object getLdapServerMetadata()
      Optional.

      The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.

    • getLogs

      @Stability(Stable) @Nullable default Object getLogs()
      Enables Amazon CloudWatch logging for brokers.

    • getMaintenanceWindowStartTime

      @Stability(Stable) @Nullable default Object getMaintenanceWindowStartTime()
      The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker.

    • getSecurityGroups

      @Stability(Stable) @Nullable default List<String> getSecurityGroups()
      The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

    • getStorageType

      @Stability(Stable) @Nullable default String getStorageType()
      The broker's storage type.

    • getSubnetIds

      @Stability(Stable) @Nullable default List<String> getSubnetIds()
      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 deployment (ACTIVEMQ) requires two subnets. A CLUSTER_MULTI_AZ deployment (RABBITMQ) 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 enpoints in VPCs that are not owned by your AWS account .

    • getTags

      @Stability(Stable) @Nullable default List<CfnBroker.TagsEntryProperty> getTags()
      An array of key-value pairs.

      For more information, see Using Cost Allocation Tags in the Billing and Cost Management User Guide .

    • builder

      @Stability(Stable) static CfnBrokerProps.Builder builder()
      Returns:
      a CfnBrokerProps.Builder of CfnBrokerProps