Class: Aws::SecurityHub::Types::AwsAmazonMqBrokerDetails

Inherits:

Struct

Object
Struct
Aws::SecurityHub::Types::AwsAmazonMqBrokerDetails

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-securityhub/types.rb

Overview

Provides details about an Amazon MQ message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#authentication_strategy ⇒ String
The authentication strategy used to secure the broker.
#auto_minor_version_upgrade ⇒ Boolean
Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ.
#broker_arn ⇒ String
The Amazon Resource Name (ARN) of the broker.
#broker_id ⇒ String
The unique ID that Amazon MQ generates for the broker.
#broker_name ⇒ String
The broker's name.
#deployment_mode ⇒ String
The broker's deployment mode.
#encryption_options ⇒ Types::AwsAmazonMqBrokerEncryptionOptionsDetails
Encryption options for the broker.
#engine_type ⇒ String
The type of broker engine.
#engine_version ⇒ String
The version of the broker engine.
#host_instance_type ⇒ String
The broker's instance type.
#ldap_server_metadata ⇒ Types::AwsAmazonMqBrokerLdapServerMetadataDetails
The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker.
#logs ⇒ Types::AwsAmazonMqBrokerLogsDetails
Turns on Amazon CloudWatch logging for brokers.
#maintenance_window_start_time ⇒ Types::AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails
The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
#publicly_accessible ⇒ Boolean
Permits connections from applications outside of the VPC that hosts the broker's subnets.
#security_groups ⇒ Array<String>
The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
#storage_type ⇒ String
The broker's storage type.
#subnet_ids ⇒ Array<String>
The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
#users ⇒ Array<Types::AwsAmazonMqBrokerUsersDetails>
The list of all broker usernames for the specified broker.

Instance Attribute Details

#authentication_strategy ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgrade ⇒ `Boolean`

Whether automatically upgrade 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.

Returns:

(Boolean)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_arn ⇒ `String`

The Amazon Resource Name (ARN) of the broker.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_id ⇒ `String`

The unique ID that Amazon MQ generates for the broker.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#broker_name ⇒ `String`

The broker's name.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_mode ⇒ `String`

The broker's deployment mode.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_options ⇒ `Types::AwsAmazonMqBrokerEncryptionOptionsDetails`

Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.

Returns:

(Types::AwsAmazonMqBrokerEncryptionOptionsDetails)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#engine_type ⇒ `String`

The type of broker engine.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

The version of the broker engine.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#host_instance_type ⇒ `String`

The broker's instance type.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#ldap_server_metadata ⇒ `Types::AwsAmazonMqBrokerLdapServerMetadataDetails`

The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.

Returns:

(Types::AwsAmazonMqBrokerLdapServerMetadataDetails)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#logs ⇒ `Types::AwsAmazonMqBrokerLogsDetails`

Turns on Amazon CloudWatch logging for brokers.

Returns:

(Types::AwsAmazonMqBrokerLogsDetails)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_window_start_time ⇒ `Types::AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails`

The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.

Returns:

(Types::AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#security_groups ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#storage_type ⇒ `String`

The broker's storage type.

Returns:

(String)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

#users ⇒ `Array<Types::AwsAmazonMqBrokerUsersDetails>`

The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.

Returns:

(Array<Types::AwsAmazonMqBrokerUsersDetails>)

# File 'lib/aws-sdk-securityhub/types.rb', line 1461

class AwsAmazonMqBrokerDetails < Struct.new(
  :authentication_strategy,
  :auto_minor_version_upgrade,
  :broker_arn,
  :broker_name,
  :deployment_mode,
  :encryption_options,
  :engine_type,
  :engine_version,
  :host_instance_type,
  :broker_id,
  :ldap_server_metadata,
  :logs,
  :maintenance_window_start_time,
  :publicly_accessible,
  :security_groups,
  :storage_type,
  :subnet_ids,
  :users)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::SecurityHub::Types::AwsAmazonMqBrokerDetails

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_strategy ⇒ String

#auto_minor_version_upgrade ⇒ Boolean

#broker_arn ⇒ String

#broker_id ⇒ String

#broker_name ⇒ String

#deployment_mode ⇒ String

#encryption_options ⇒ Types::AwsAmazonMqBrokerEncryptionOptionsDetails

#engine_type ⇒ String

#engine_version ⇒ String

#host_instance_type ⇒ String

#ldap_server_metadata ⇒ Types::AwsAmazonMqBrokerLdapServerMetadataDetails

#logs ⇒ Types::AwsAmazonMqBrokerLogsDetails

#maintenance_window_start_time ⇒ Types::AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails

#publicly_accessible ⇒ Boolean

#security_groups ⇒ Array<String>

#storage_type ⇒ String

#subnet_ids ⇒ Array<String>

#users ⇒ Array<Types::AwsAmazonMqBrokerUsersDetails>

#authentication_strategy ⇒ `String`

#auto_minor_version_upgrade ⇒ `Boolean`

#broker_arn ⇒ `String`

#broker_id ⇒ `String`

#broker_name ⇒ `String`

#deployment_mode ⇒ `String`

#encryption_options ⇒ `Types::AwsAmazonMqBrokerEncryptionOptionsDetails`

#engine_type ⇒ `String`

#engine_version ⇒ `String`

#host_instance_type ⇒ `String`

#ldap_server_metadata ⇒ `Types::AwsAmazonMqBrokerLdapServerMetadataDetails`

#logs ⇒ `Types::AwsAmazonMqBrokerLogsDetails`

#maintenance_window_start_time ⇒ `Types::AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails`

#publicly_accessible ⇒ `Boolean`

#security_groups ⇒ `Array<String>`

#storage_type ⇒ `String`

#subnet_ids ⇒ `Array<String>`

#users ⇒ `Array<Types::AwsAmazonMqBrokerUsersDetails>`