Class: Aws::FMS::Types::AdminAccountSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb

Overview

Contains high level information about the Firewall Manager administrator account.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_accountString

The Amazon Web Services account ID of the Firewall Manager administrator's account.

Returns:

  • (String)


121
122
123
124
125
126
127
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 121

class AdminAccountSummary < Struct.new(
  :admin_account,
  :default_admin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#default_adminBoolean

A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

Returns:

  • (Boolean)


121
122
123
124
125
126
127
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 121

class AdminAccountSummary < Struct.new(
  :admin_account,
  :default_admin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the request to onboard a member account as an Firewall Manager administrator.

  • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

  • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

  • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

  • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

Returns:

  • (String)


121
122
123
124
125
126
127
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 121

class AdminAccountSummary < Struct.new(
  :admin_account,
  :default_admin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end