AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Firewall Management Service PutAdminAccount API operation.

Syntax

Write-FMSAdminAccount
-AdminAccount <String>
-AccountScope_Account <String[]>
-AccountScope_AllAccountsEnabled <Boolean>
-OrganizationalUnitScope_AllOrganizationalUnitsEnabled <Boolean>
-PolicyTypeScope_AllPolicyTypesEnabled <Boolean>
-RegionScope_AllRegionsEnabled <Boolean>
-AccountScope_ExcludeSpecifiedAccount <Boolean>
-OrganizationalUnitScope_ExcludeSpecifiedOrganizationalUnit <Boolean>
-OrganizationalUnitScope_OrganizationalUnit <String[]>
-PolicyTypeScope_PolicyType <String[]>
-RegionScope_Region <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonFMSConfig>

Description

Creates or updates an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. Only the organization's management account can create an Firewall Manager administrator account. When you create an Firewall Manager administrator account, the service checks to see if the account is already a delegated administrator within Organizations. If the account isn't a delegated administrator, Firewall Manager calls Organizations to delegate the account within Organizations. For more information about administrator accounts within Organizations, see Managing the Amazon Web Services Accounts in Your Organization.

Parameters

-AccountScope_Account <String[]>
The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_AccountScope_Accounts
-AccountScope_AllAccountsEnabled <Boolean>
A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_AccountScope_AllAccountsEnabled
-AccountScope_ExcludeSpecifiedAccount <Boolean>
A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_AccountScope_ExcludeSpecifiedAccounts
-AdminAccount <String>
The Amazon Web Services account ID to add as an Firewall Manager administrator account. The account must be a member of the organization that was onboarded to Firewall Manager by AssociateAdminAccount. For more information about Organizations, see Managing the Amazon Web Services Accounts in Your Organization.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonFMSConfig>
Amazon.PowerShell.Cmdlets.FMS.AmazonFMSClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OrganizationalUnitScope_AllOrganizationalUnitsEnabled <Boolean>
A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in OrganizationalUnitScope$OrganizationalUnits. You cannot specify both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_OrganizationalUnitScope_AllOrganizationalUnitsEnabled
-OrganizationalUnitScope_ExcludeSpecifiedOrganizationalUnit <Boolean>
A boolean value that excludes the OUs in OrganizationalUnitScope$OrganizationalUnits from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed in OrganizationalUnitScope$OrganizationalUnits. You can either specify a list of OUs to exclude by OrganizationalUnitScope$OrganizationalUnits, or you can enable management of all OUs by OrganizationalUnitScope$AllOrganizationalUnitsEnabled. You cannot specify both.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_OrganizationalUnitScope_ExcludeSpecifiedOrganizationalUnits
-OrganizationalUnitScope_OrganizationalUnit <String[]>
The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to true, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. If OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits is set to false, then the Firewall Manager administrator can only apply policies to the OUs in this list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_OrganizationalUnitScope_OrganizationalUnits
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the AdminAccount parameter. The -PassThru parameter is deprecated, use -Select '^AdminAccount' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PolicyTypeScope_AllPolicyTypesEnabled <Boolean>
Allows the specified Firewall Manager administrator to manage all Firewall Manager policy types, except for third-party policy types. Third-party policy types can only be managed by the Firewall Manager default administrator.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_PolicyTypeScope_AllPolicyTypesEnabled
-PolicyTypeScope_PolicyType <String[]>
The list of policy types that the specified Firewall Manager administrator can manage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_PolicyTypeScope_PolicyTypes
-RegionScope_AllRegionsEnabled <Boolean>
Allows the specified Firewall Manager administrator to manage all Amazon Web Services Regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_RegionScope_AllRegionsEnabled
-RegionScope_Region <String[]>
The Amazon Web Services Regions that the specified Firewall Manager administrator can perform actions in.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdminScope_RegionScope_Regions
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.PutAdminAccountResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.FMS.Model.PutAdminAccountResponse
This cmdlet does not generate any output.The service response (type Amazon.FMS.Model.PutAdminAccountResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z