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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_strategy ⇒ String

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

Returns:

  • (String) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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:



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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:



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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:



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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:



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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>) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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>) 


1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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:



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 1441

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