@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeBrokerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
DescribeBrokerResult() |
Modifier and Type | Method and Description |
---|---|
DescribeBrokerResult |
clone() |
boolean |
equals(Object obj) |
Boolean |
getAutoMinorVersionUpgrade()
Required.
|
String |
getBrokerArn()
The Amazon Resource Name (ARN) of the broker.
|
String |
getBrokerId()
The unique ID that Amazon MQ generates for the broker.
|
List<BrokerInstance> |
getBrokerInstances()
A list of information about allocated brokers.
|
String |
getBrokerName()
The name of the broker.
|
String |
getBrokerState()
The status of the broker.
|
Configurations |
getConfigurations()
The list of all revisions for the specified configuration.
|
String |
getDeploymentMode()
Required.
|
String |
getEngineType()
Required.
|
String |
getEngineVersion()
The version of the broker engine.
|
String |
getHostInstanceType()
The broker's instance type.
|
WeeklyStartTime |
getMaintenanceWindowStartTime()
The parameters that determine the WeeklyStartTime.
|
Boolean |
getPubliclyAccessible()
Required.
|
List<String> |
getSecurityGroups()
Required.
|
List<String> |
getSubnetIds()
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different
Availability Zones.
|
List<UserSummary> |
getUsers()
The list of all ActiveMQ usernames for the specified broker.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Required.
|
Boolean |
isPubliclyAccessible()
Required.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Required.
|
void |
setBrokerArn(String brokerArn)
The Amazon Resource Name (ARN) of the broker.
|
void |
setBrokerId(String brokerId)
The unique ID that Amazon MQ generates for the broker.
|
void |
setBrokerInstances(Collection<BrokerInstance> brokerInstances)
A list of information about allocated brokers.
|
void |
setBrokerName(String brokerName)
The name of the broker.
|
void |
setBrokerState(String brokerState)
The status of the broker.
|
void |
setConfigurations(Configurations configurations)
The list of all revisions for the specified configuration.
|
void |
setDeploymentMode(String deploymentMode)
Required.
|
void |
setEngineType(String engineType)
Required.
|
void |
setEngineVersion(String engineVersion)
The version of the broker engine.
|
void |
setHostInstanceType(String hostInstanceType)
The broker's instance type.
|
void |
setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
The parameters that determine the WeeklyStartTime.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Required.
|
void |
setSecurityGroups(Collection<String> securityGroups)
Required.
|
void |
setSubnetIds(Collection<String> subnetIds)
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different
Availability Zones.
|
void |
setUsers(Collection<UserSummary> users)
The list of all ActiveMQ usernames for the specified broker.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
DescribeBrokerResult |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Required.
|
DescribeBrokerResult |
withBrokerArn(String brokerArn)
The Amazon Resource Name (ARN) of the broker.
|
DescribeBrokerResult |
withBrokerId(String brokerId)
The unique ID that Amazon MQ generates for the broker.
|
DescribeBrokerResult |
withBrokerInstances(BrokerInstance... brokerInstances)
A list of information about allocated brokers.
|
DescribeBrokerResult |
withBrokerInstances(Collection<BrokerInstance> brokerInstances)
A list of information about allocated brokers.
|
DescribeBrokerResult |
withBrokerName(String brokerName)
The name of the broker.
|
DescribeBrokerResult |
withBrokerState(BrokerState brokerState)
The status of the broker.
|
DescribeBrokerResult |
withBrokerState(String brokerState)
The status of the broker.
|
DescribeBrokerResult |
withConfigurations(Configurations configurations)
The list of all revisions for the specified configuration.
|
DescribeBrokerResult |
withDeploymentMode(DeploymentMode deploymentMode)
Required.
|
DescribeBrokerResult |
withDeploymentMode(String deploymentMode)
Required.
|
DescribeBrokerResult |
withEngineType(EngineType engineType)
Required.
|
DescribeBrokerResult |
withEngineType(String engineType)
Required.
|
DescribeBrokerResult |
withEngineVersion(String engineVersion)
The version of the broker engine.
|
DescribeBrokerResult |
withHostInstanceType(String hostInstanceType)
The broker's instance type.
|
DescribeBrokerResult |
withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
The parameters that determine the WeeklyStartTime.
|
DescribeBrokerResult |
withPubliclyAccessible(Boolean publiclyAccessible)
Required.
|
DescribeBrokerResult |
withSecurityGroups(Collection<String> securityGroups)
Required.
|
DescribeBrokerResult |
withSecurityGroups(String... securityGroups)
Required.
|
DescribeBrokerResult |
withSubnetIds(Collection<String> subnetIds)
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different
Availability Zones.
|
DescribeBrokerResult |
withSubnetIds(String... subnetIds)
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different
Availability Zones.
|
DescribeBrokerResult |
withUsers(Collection<UserSummary> users)
The list of all ActiveMQ usernames for the specified broker.
|
DescribeBrokerResult |
withUsers(UserSummary... users)
The list of all ActiveMQ usernames for the specified broker.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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.public Boolean getAutoMinorVersionUpgrade()
public DescribeBrokerResult withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
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.public Boolean isAutoMinorVersionUpgrade()
public void setBrokerArn(String brokerArn)
brokerArn
- The Amazon Resource Name (ARN) of the broker.public String getBrokerArn()
public DescribeBrokerResult withBrokerArn(String brokerArn)
brokerArn
- The Amazon Resource Name (ARN) of the broker.public void setBrokerId(String brokerId)
brokerId
- The unique ID that Amazon MQ generates for the broker.public String getBrokerId()
public DescribeBrokerResult withBrokerId(String brokerId)
brokerId
- The unique ID that Amazon MQ generates for the broker.public List<BrokerInstance> getBrokerInstances()
public void setBrokerInstances(Collection<BrokerInstance> brokerInstances)
brokerInstances
- A list of information about allocated brokers.public DescribeBrokerResult withBrokerInstances(BrokerInstance... brokerInstances)
NOTE: This method appends the values to the existing list (if any). Use
setBrokerInstances(java.util.Collection)
or withBrokerInstances(java.util.Collection)
if you
want to override the existing values.
brokerInstances
- A list of information about allocated brokers.public DescribeBrokerResult withBrokerInstances(Collection<BrokerInstance> brokerInstances)
brokerInstances
- A list of information about allocated brokers.public void setBrokerName(String brokerName)
brokerName
- 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.public String getBrokerName()
public DescribeBrokerResult withBrokerName(String brokerName)
brokerName
- 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.public void setBrokerState(String brokerState)
brokerState
- The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS,
RUNNING, REBOOT_IN_PROGRESSBrokerState
public String getBrokerState()
BrokerState
public DescribeBrokerResult withBrokerState(String brokerState)
brokerState
- The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS,
RUNNING, REBOOT_IN_PROGRESSBrokerState
public DescribeBrokerResult withBrokerState(BrokerState brokerState)
brokerState
- The status of the broker. Possible values: CREATION_IN_PROGRESS, CREATION_FAILED, DELETION_IN_PROGRESS,
RUNNING, REBOOT_IN_PROGRESSBrokerState
public void setConfigurations(Configurations configurations)
configurations
- The list of all revisions for the specified configuration.public Configurations getConfigurations()
public DescribeBrokerResult withConfigurations(Configurations configurations)
configurations
- The list of all revisions for the specified configuration.public void setDeploymentMode(String deploymentMode)
deploymentMode
- Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ
creates an active/standby broker for high availability.DeploymentMode
public String getDeploymentMode()
DeploymentMode
public DescribeBrokerResult withDeploymentMode(String deploymentMode)
deploymentMode
- Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ
creates an active/standby broker for high availability.DeploymentMode
public DescribeBrokerResult withDeploymentMode(DeploymentMode deploymentMode)
deploymentMode
- Required. The deployment mode of the broker. Possible values: SINGLE_INSTANCE, ACTIVE_STANDBY_MULTI_AZ
SINGLE_INSTANCE creates a single-instance broker in a single Availability Zone. ACTIVE_STANDBY_MULTI_AZ
creates an active/standby broker for high availability.DeploymentMode
public void setEngineType(String engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.EngineType
public String getEngineType()
EngineType
public DescribeBrokerResult withEngineType(String engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.EngineType
public DescribeBrokerResult withEngineType(EngineType engineType)
engineType
- Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.EngineType
public void setEngineVersion(String engineVersion)
engineVersion
- The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.public String getEngineVersion()
public DescribeBrokerResult withEngineVersion(String engineVersion)
engineVersion
- The version of the broker engine. Note: Currently, Amazon MQ supports only 5.15.0.public void setHostInstanceType(String hostInstanceType)
hostInstanceType
- The broker's instance type. Possible values: mq.t2.micro, mq.m4.largepublic String getHostInstanceType()
public DescribeBrokerResult withHostInstanceType(String hostInstanceType)
hostInstanceType
- The broker's instance type. Possible values: mq.t2.micro, mq.m4.largepublic void setMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
maintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.public WeeklyStartTime getMaintenanceWindowStartTime()
public DescribeBrokerResult withMaintenanceWindowStartTime(WeeklyStartTime maintenanceWindowStartTime)
maintenanceWindowStartTime
- The parameters that determine the WeeklyStartTime.public void setPubliclyAccessible(Boolean publiclyAccessible)
publiclyAccessible
- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.public Boolean getPubliclyAccessible()
public DescribeBrokerResult withPubliclyAccessible(Boolean publiclyAccessible)
publiclyAccessible
- Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.public Boolean isPubliclyAccessible()
public List<String> getSecurityGroups()
public void setSecurityGroups(Collection<String> securityGroups)
securityGroups
- Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.public DescribeBrokerResult withSecurityGroups(String... securityGroups)
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroups(java.util.Collection)
or withSecurityGroups(java.util.Collection)
if you want
to override the existing values.
securityGroups
- Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.public DescribeBrokerResult withSecurityGroups(Collection<String> securityGroups)
securityGroups
- Required. The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.public List<String> getSubnetIds()
public void setSubnetIds(Collection<String> subnetIds)
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.public DescribeBrokerResult withSubnetIds(String... subnetIds)
NOTE: This method appends the values to the existing list (if any). Use
setSubnetIds(java.util.Collection)
or withSubnetIds(java.util.Collection)
if you want to
override the existing values.
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.public DescribeBrokerResult withSubnetIds(Collection<String> subnetIds)
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.public List<UserSummary> getUsers()
public void setUsers(Collection<UserSummary> users)
users
- The list of all ActiveMQ usernames for the specified broker.public DescribeBrokerResult withUsers(UserSummary... users)
NOTE: This method appends the values to the existing list (if any). Use
setUsers(java.util.Collection)
or withUsers(java.util.Collection)
if you want to override the
existing values.
users
- The list of all ActiveMQ usernames for the specified broker.public DescribeBrokerResult withUsers(Collection<UserSummary> users)
users
- The list of all ActiveMQ usernames for the specified broker.public String toString()
toString
in class Object
Object.toString()
public DescribeBrokerResult clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.