libZSservicesZSamazonka-mqZSamazonka-mq
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MQ.DescribeBroker

Description

Returns information about the specified broker.

Synopsis

Creating a Request

data DescribeBroker Source #

See: newDescribeBroker smart constructor.

Constructors

DescribeBroker' 

Fields

  • brokerId :: Text

    The unique ID that Amazon MQ generates for the broker.

Instances

Instances details
Eq DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Read DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Show DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Generic DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Associated Types

type Rep DescribeBroker :: Type -> Type #

NFData DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

rnf :: DescribeBroker -> () #

Hashable DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

AWSRequest DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Associated Types

type AWSResponse DescribeBroker #

ToHeaders DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

ToPath DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

ToQuery DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

type Rep DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

type Rep DescribeBroker = D1 ('MetaData "DescribeBroker" "Amazonka.MQ.DescribeBroker" "libZSservicesZSamazonka-mqZSamazonka-mq" 'False) (C1 ('MetaCons "DescribeBroker'" 'PrefixI 'True) (S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeBroker Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

newDescribeBroker Source #

Create a value of DescribeBroker with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:brokerId:DescribeBroker', describeBroker_brokerId - The unique ID that Amazon MQ generates for the broker.

Request Lenses

describeBroker_brokerId :: Lens' DescribeBroker Text Source #

The unique ID that Amazon MQ generates for the broker.

Destructuring the Response

data DescribeBrokerResponse Source #

See: newDescribeBrokerResponse smart constructor.

Constructors

DescribeBrokerResponse' 

Fields

Instances

Instances details
Eq DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Read DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Show DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Generic DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Associated Types

type Rep DescribeBrokerResponse :: Type -> Type #

NFData DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

Methods

rnf :: DescribeBrokerResponse -> () #

type Rep DescribeBrokerResponse Source # 
Instance details

Defined in Amazonka.MQ.DescribeBroker

type Rep DescribeBrokerResponse = D1 ('MetaData "DescribeBrokerResponse" "Amazonka.MQ.DescribeBroker" "libZSservicesZSamazonka-mqZSamazonka-mq" 'False) (C1 ('MetaCons "DescribeBrokerResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "brokerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pendingAuthenticationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationStrategy)))) :*: ((S1 ('MetaSel ('Just "brokerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerState)) :*: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserSummary])) :*: (S1 ('MetaSel ('Just "pendingSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Configurations))) :*: (S1 ('MetaSel ('Just "authenticationStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationStrategy)) :*: S1 ('MetaSel ('Just "pendingHostInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "ldapServerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LdapServerMetadataOutput)) :*: (S1 ('MetaSel ('Just "maintenanceWindowStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WeeklyStartTime)) :*: S1 ('MetaSel ('Just "logs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogsSummary)))) :*: ((S1 ('MetaSel ('Just "encryptionOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionOptions)) :*: S1 ('MetaSel ('Just "deploymentMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentMode))) :*: (S1 ('MetaSel ('Just "pendingEngineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "brokerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "pendingLdapServerMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LdapServerMetadataOutput)) :*: S1 ('MetaSel ('Just "engineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EngineType))) :*: (S1 ('MetaSel ('Just "brokerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: ((S1 ('MetaSel ('Just "brokerInstances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BrokerInstance])) :*: S1 ('MetaSel ('Just "hostInstanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BrokerStorageType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeBrokerResponse Source #

Create a value of DescribeBrokerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:brokerName:DescribeBrokerResponse', describeBrokerResponse_brokerName - The broker's name. 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.

$sel:engineVersion:DescribeBrokerResponse', describeBrokerResponse_engineVersion - The broker engine's version. For a list of supported engine versions, see Supported engines.

$sel:pendingAuthenticationStrategy:DescribeBrokerResponse', describeBrokerResponse_pendingAuthenticationStrategy - The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

$sel:brokerState:DescribeBrokerResponse', describeBrokerResponse_brokerState - The broker's status.

$sel:publiclyAccessible:DescribeBrokerResponse', describeBrokerResponse_publiclyAccessible - Enables connections from applications outside of the VPC that hosts the broker's subnets.

$sel:autoMinorVersionUpgrade:DescribeBrokerResponse', describeBrokerResponse_autoMinorVersionUpgrade - Enables automatic upgrades to new minor versions for brokers, as new 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.

$sel:securityGroups:DescribeBrokerResponse', describeBrokerResponse_securityGroups - The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

$sel:users:DescribeBrokerResponse', describeBrokerResponse_users - The list of all broker usernames for the specified broker.

$sel:pendingSecurityGroups:DescribeBrokerResponse', describeBrokerResponse_pendingSecurityGroups - The list of pending security groups to authorize connections to brokers.

$sel:subnetIds:DescribeBrokerResponse', describeBrokerResponse_subnetIds - The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

$sel:created:DescribeBrokerResponse', describeBrokerResponse_created - The time when the broker was created.

$sel:configurations:DescribeBrokerResponse', describeBrokerResponse_configurations - The list of all revisions for the specified configuration.

$sel:authenticationStrategy:DescribeBrokerResponse', describeBrokerResponse_authenticationStrategy - The authentication strategy used to secure the broker. The default is SIMPLE.

$sel:pendingHostInstanceType:DescribeBrokerResponse', describeBrokerResponse_pendingHostInstanceType - The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

$sel:ldapServerMetadata:DescribeBrokerResponse', describeBrokerResponse_ldapServerMetadata - The metadata of the LDAP server used to authenticate and authorize connections to the broker.

$sel:maintenanceWindowStartTime:DescribeBrokerResponse', describeBrokerResponse_maintenanceWindowStartTime - The parameters that determine the WeeklyStartTime.

$sel:logs:DescribeBrokerResponse', describeBrokerResponse_logs - The list of information about logs currently enabled and pending to be deployed for the specified broker.

$sel:encryptionOptions:DescribeBrokerResponse', describeBrokerResponse_encryptionOptions - Encryption options for the broker. Does not apply to RabbitMQ brokers.

$sel:deploymentMode:DescribeBrokerResponse', describeBrokerResponse_deploymentMode - The broker's deployment mode.

$sel:pendingEngineVersion:DescribeBrokerResponse', describeBrokerResponse_pendingEngineVersion - The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

$sel:brokerId:DescribeBroker', describeBrokerResponse_brokerId - The unique ID that Amazon MQ generates for the broker.

$sel:pendingLdapServerMetadata:DescribeBrokerResponse', describeBrokerResponse_pendingLdapServerMetadata - The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

$sel:engineType:DescribeBrokerResponse', describeBrokerResponse_engineType - The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

$sel:brokerArn:DescribeBrokerResponse', describeBrokerResponse_brokerArn - The broker's Amazon Resource Name (ARN).

$sel:tags:DescribeBrokerResponse', describeBrokerResponse_tags - The list of all tags associated with this broker.

$sel:brokerInstances:DescribeBrokerResponse', describeBrokerResponse_brokerInstances - A list of information about allocated brokers.

$sel:hostInstanceType:DescribeBrokerResponse', describeBrokerResponse_hostInstanceType - The broker's instance type.

$sel:storageType:DescribeBrokerResponse', describeBrokerResponse_storageType - The broker's storage type.

$sel:httpStatus:DescribeBrokerResponse', describeBrokerResponse_httpStatus - The response's http status code.

Response Lenses

describeBrokerResponse_brokerName :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's name. 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.

describeBrokerResponse_engineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker engine's version. For a list of supported engine versions, see Supported engines.

describeBrokerResponse_pendingAuthenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #

The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.

describeBrokerResponse_publiclyAccessible :: Lens' DescribeBrokerResponse (Maybe Bool) Source #

Enables connections from applications outside of the VPC that hosts the broker's subnets.

describeBrokerResponse_autoMinorVersionUpgrade :: Lens' DescribeBrokerResponse (Maybe Bool) Source #

Enables automatic upgrades to new minor versions for brokers, as new 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.

describeBrokerResponse_securityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.

describeBrokerResponse_users :: Lens' DescribeBrokerResponse (Maybe [UserSummary]) Source #

The list of all broker usernames for the specified broker.

describeBrokerResponse_pendingSecurityGroups :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of pending security groups to authorize connections to brokers.

describeBrokerResponse_subnetIds :: Lens' DescribeBrokerResponse (Maybe [Text]) Source #

The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

describeBrokerResponse_configurations :: Lens' DescribeBrokerResponse (Maybe Configurations) Source #

The list of all revisions for the specified configuration.

describeBrokerResponse_authenticationStrategy :: Lens' DescribeBrokerResponse (Maybe AuthenticationStrategy) Source #

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

describeBrokerResponse_pendingHostInstanceType :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.

describeBrokerResponse_ldapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #

The metadata of the LDAP server used to authenticate and authorize connections to the broker.

describeBrokerResponse_logs :: Lens' DescribeBrokerResponse (Maybe LogsSummary) Source #

The list of information about logs currently enabled and pending to be deployed for the specified broker.

describeBrokerResponse_encryptionOptions :: Lens' DescribeBrokerResponse (Maybe EncryptionOptions) Source #

Encryption options for the broker. Does not apply to RabbitMQ brokers.

describeBrokerResponse_pendingEngineVersion :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

describeBrokerResponse_brokerId :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The unique ID that Amazon MQ generates for the broker.

describeBrokerResponse_pendingLdapServerMetadata :: Lens' DescribeBrokerResponse (Maybe LdapServerMetadataOutput) Source #

The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

describeBrokerResponse_engineType :: Lens' DescribeBrokerResponse (Maybe EngineType) Source #

The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

describeBrokerResponse_brokerArn :: Lens' DescribeBrokerResponse (Maybe Text) Source #

The broker's Amazon Resource Name (ARN).

describeBrokerResponse_tags :: Lens' DescribeBrokerResponse (Maybe (HashMap Text Text)) Source #

The list of all tags associated with this broker.