CreateBrokerRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.mq.model.MqRequest
    - - software.amazon.awssdk.services.mq.model.CreateBrokerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateBrokerRequest
extends MqRequest
implements ToCopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>

Creates a broker using the specified properties.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateBrokerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateBrokerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`autoMinorVersionUpgrade()` Required.
`String`	`brokerName()` Required.
`static CreateBrokerRequest.Builder`	`builder()`
`ConfigurationId`	`configuration()` A list of information about the configuration.
`String`	`creatorRequestId()` The unique ID that the requester receives for the created broker.
`DeploymentMode`	`deploymentMode()` Required.
`String`	`deploymentModeAsString()` Required.
`EngineType`	`engineType()` Required.
`String`	`engineTypeAsString()` Required.
`String`	`engineVersion()` Required.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`hostInstanceType()` Required.
`Logs`	`logs()` Enables Amazon CloudWatch logging for brokers.
`WeeklyStartTime`	`maintenanceWindowStartTime()` The parameters that determine the WeeklyStartTime.
`Boolean`	`publiclyAccessible()` Required.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
`static Class<? extends CreateBrokerRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnetIds()` The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones.
`CreateBrokerRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`List<User>`	`users()` Required.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - autoMinorVersionUpgrade
```
public Boolean autoMinorVersionUpgrade()
```
    Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
  - brokerName
```
public String brokerName()
```
    Required. 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 whitespaces, brackets, wildcard characters, or special characters.
    
    Returns:
    
    Required. 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 whitespaces, brackets, wildcard characters, or special characters.
  - configuration
```
public ConfigurationId configuration()
```
    A list of information about the configuration.
    
    Returns:
    
    A list of information about the configuration.
  - creatorRequestId
```
public String creatorRequestId()
```
    The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
    
    Returns:
    
    The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.
  - deploymentMode
```
public DeploymentMode deploymentMode()
```
    Required. The deployment mode of the broker.
    If the service returns an enum value that is not available in the current SDK version, deploymentMode will return DeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().
    
    Returns:
    
    Required. The deployment mode of the broker.
    
    See Also:
    
    DeploymentMode
  - deploymentModeAsString
```
public String deploymentModeAsString()
```
    Required. The deployment mode of the broker.
    If the service returns an enum value that is not available in the current SDK version, deploymentMode will return DeploymentMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentModeAsString().
    
    Returns:
    
    Required. The deployment mode of the broker.
    
    See Also:
    
    DeploymentMode
  - engineType
```
public EngineType engineType()
```
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    If the service returns an enum value that is not available in the current SDK version, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().
    
    Returns:
    
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    See Also:
    
    EngineType
  - engineTypeAsString
```
public String engineTypeAsString()
```
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    If the service returns an enum value that is not available in the current SDK version, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().
    
    Returns:
    
    Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.
    
    See Also:
    
    EngineType
  - engineVersion
```
public String engineVersion()
```
    Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.
    
    Returns:
    
    Required. The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.6 and 5.15.0.
  - hostInstanceType
```
public String hostInstanceType()
```
    Required. The broker's instance type.
    
    Returns:
    
    Required. The broker's instance type.
  - logs
```
public Logs logs()
```
    Enables Amazon CloudWatch logging for brokers.
    
    Returns:
    
    Enables Amazon CloudWatch logging for brokers.
  - maintenanceWindowStartTime
```
public WeeklyStartTime maintenanceWindowStartTime()
```
    The parameters that determine the WeeklyStartTime.
    
    Returns:
    
    The parameters that determine the WeeklyStartTime.
  - publiclyAccessible
```
public Boolean publiclyAccessible()
```
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
    
    Returns:
    
    Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.
  - securityGroups
```
public List<String> securityGroups()
```
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
  - subnetIds
```
public List<String> subnetIds()
```
    The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.
  - users
```
public List<User> users()
```
    Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
  - toBuilder
```
public CreateBrokerRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateBrokerRequest.Builder,CreateBrokerRequest>
    
    Specified by:
    
    toBuilder in class MqRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateBrokerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateBrokerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CreateBrokerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

autoMinorVersionUpgrade

brokerName

configuration

creatorRequestId

deploymentMode

deploymentModeAsString

engineType

engineTypeAsString

engineVersion

hostInstanceType

logs

maintenanceWindowStartTime

publiclyAccessible

securityGroups

subnetIds

users

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields