AWS.Tools.FMS.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.FMS</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet"> <summary> Sets the Firewall Manager administrator account. The account must be a member of the organization in Organizations whose resources you want to protect. Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies. <para> The account that you associate with Firewall Manager is called the Firewall Manager administrator account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet.AdminAccount"> <summary> <para> <para>The Amazon Web Services account ID to associate with Firewall Manager as the Firewall Manager administrator account. This must be an Organizations member account. For more information about Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html">Managing the Amazon Web Services Accounts in Your Organization</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet.Select"> <summary> 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.AssociateAdminAccountResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.AddFMSResourceTagCmdlet"> <summary> Adds one or more tags to an Amazon Web Services resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSResourceTagCmdlet.TagList"> <summary> <para> <para>The tags to add to the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSResourceTagCmdlet.Select"> <summary> 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.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSAdminAccountCmdlet"> <summary> Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager administrator. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAdminAccountCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetAdminAccountResponse). Specifying the name of a property of type Amazon.FMS.Model.GetAdminAccountResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppListCmdlet"> <summary> Returns information about the specified Firewall Manager applications list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppListCmdlet.DefaultList"> <summary> <para> <para>Specifies whether the list to retrieve is a default list owned by Firewall Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppListCmdlet.ListId"> <summary> <para> <para>The ID of the Firewall Manager applications list that you want the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetAppsListResponse). Specifying the name of a property of type Amazon.FMS.Model.GetAppsListResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListId parameter. The -PassThru parameter is deprecated, use -Select '^ListId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet"> <summary> Returns an array of <code>AppsListDataSummary</code> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet.DefaultList"> <summary> <para> <para>Specifies whether the lists to retrieve are default lists owned by Firewall Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</para><para>If you don't specify this, Firewall Manager returns all available objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet.NextToken"> <summary> <para> <para>If you specify a value for <code>MaxResults</code> in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AppsLists'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListAppsListsResponse). Specifying the name of a property of type Amazon.FMS.Model.ListAppsListsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DefaultList parameter. The -PassThru parameter is deprecated, use -Select '^DefaultList' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSAppsListListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceDetailCmdlet"> <summary> Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. <ul><li><para> Resources are considered noncompliant for WAF and Shield Advanced policies if the specified policy has not been applied to them. </para></li><li><para> Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible. </para></li><li><para> Resources are considered noncompliant for Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules. </para></li><li><para> Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceDetailCmdlet.MemberAccount"> <summary> <para> <para>The Amazon Web Services account that owns the resources that you want to get the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceDetailCmdlet.PolicyId"> <summary> <para> <para>The ID of the policy that you want to get the details for. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyComplianceDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetComplianceDetailResponse). Specifying the name of a property of type Amazon.FMS.Model.GetComplianceDetailResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet"> <summary> Returns an array of <code>PolicyComplianceStatus</code> objects. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected by the specified policy.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.PolicyId"> <summary> <para> <para>The ID of the Firewall Manager policy that you want the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.MaxResult"> <summary> <para> <para>Specifies the number of <code>PolicyComplianceStatus</code> objects that you want Firewall Manager to return for this request. If you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicyComplianceStatus</code> objects.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.NextToken"> <summary> <para> <para>If you specify a value for <code>MaxResults</code> and you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicyComplianceStatus</code> objects. For the second and subsequent <code>ListComplianceStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicyComplianceStatus</code> objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyComplianceStatusList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListComplianceStatusResponse). Specifying the name of a property of type Amazon.FMS.Model.ListComplianceStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSMemberAccountListCmdlet"> <summary> Returns a <code>MemberAccounts</code> object that lists the member accounts in the administrator's Amazon Web Services organization. <para> The <code>ListMemberAccounts</code> must be submitted by the account that is set as the Firewall Manager administrator. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSMemberAccountListCmdlet.MaxResult"> <summary> <para> <para>Specifies the number of member account IDs that you want Firewall Manager to return for this request. If you have more IDs than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of member account IDs.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSMemberAccountListCmdlet.NextToken"> <summary> <para> <para>If you specify a value for <code>MaxResults</code> and you have more account IDs than the number that you specify for <code>MaxResults</code>, Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of IDs. For the second and subsequent <code>ListMemberAccountsRequest</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of member account IDs.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSMemberAccountListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MemberAccounts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListMemberAccountsResponse). Specifying the name of a property of type Amazon.FMS.Model.ListMemberAccountsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSMemberAccountListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSNotificationChannelCmdlet"> <summary> Information about the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSNotificationChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetNotificationChannelResponse). Specifying the name of a property of type Amazon.FMS.Model.GetNotificationChannelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyCmdlet"> <summary> Returns information about the specified Firewall Manager policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyCmdlet.PolicyId"> <summary> <para> <para>The ID of the Firewall Manager policy that you want the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetPolicyResponse). Specifying the name of a property of type Amazon.FMS.Model.GetPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyListCmdlet"> <summary> Returns an array of <code>PolicySummary</code> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyListCmdlet.MaxResult"> <summary> <para> <para>Specifies the number of <code>PolicySummary</code> objects that you want Firewall Manager to return for this request. If you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicySummary</code> objects.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyListCmdlet.NextToken"> <summary> <para> <para>If you specify a value for <code>MaxResults</code> and you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicySummary</code> objects. For the second and subsequent <code>ListPolicies</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicySummary</code> objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListPoliciesResponse). Specifying the name of a property of type Amazon.FMS.Model.ListPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet"> <summary> If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.<br/><br/>In the AWS.Tools.FMS module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.EndTime"> <summary> <para> <para>The end of the time period to query for the attacks. This is a <code>timestamp</code> type. The request syntax listing indicates a <code>number</code> type because the default used by Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.MemberAccountId"> <summary> <para> <para>The Amazon Web Services account that is in scope of the policy that you want to get the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.PolicyId"> <summary> <para> <para>The ID of the policy for which you want to get the attack information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.StartTime"> <summary> <para> <para>The start of the time period to query for the attacks. This is a <code>timestamp</code> type. The request syntax listing indicates a <code>number</code> type because the default used by Firewall Manager is Unix time in seconds. However, any valid <code>timestamp</code> format is allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.MaxResult"> <summary> <para> <para>Specifies the number of objects that you want Firewall Manager to return for this request. If you have more objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.NextToken"> <summary> <para> <para>If you specify a value for <code>MaxResults</code> and you have more objects than the number that you specify for <code>MaxResults</code>, Firewall Manager returns a <code>NextToken</code> value in the response, which you can use to retrieve another group of objects. For the second and subsequent <code>GetProtectionStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of objects.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.FMS module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetProtectionStatusResponse). Specifying the name of a property of type Amazon.FMS.Model.GetProtectionStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtectionStatusCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolListCmdlet"> <summary> Returns information about the specified Firewall Manager protocols list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolListCmdlet.DefaultList"> <summary> <para> <para>Specifies whether the list to retrieve is a default list owned by Firewall Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolListCmdlet.ListId"> <summary> <para> <para>The ID of the Firewall Manager protocols list that you want the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetProtocolsListResponse). Specifying the name of a property of type Amazon.FMS.Model.GetProtocolsListResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListId parameter. The -PassThru parameter is deprecated, use -Select '^ListId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet"> <summary> Returns an array of <code>ProtocolsListDataSummary</code> objects.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet.DefaultList"> <summary> <para> <para>Specifies whether the lists to retrieve are default lists owned by Firewall Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of objects that you want Firewall Manager to return for this request. If more objects are available, in the response, Firewall Manager provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</para><para>If you don't specify this, Firewall Manager returns all available objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet.NextToken"> <summary> <para> <para>If you specify a value for <code>MaxResults</code> in your list request, and you have more objects than the maximum, Firewall Manager returns this token in the response. For all but the first request, you provide the token returned by the prior request in the request parameters, to retrieve the next batch of objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProtocolsLists'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListProtocolsListsResponse). Specifying the name of a property of type Amazon.FMS.Model.ListProtocolsListsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DefaultList parameter. The -PassThru parameter is deprecated, use -Select '^DefaultList' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSProtocolsListListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSResourceTagCmdlet"> <summary> Retrieves the list of tags for the specified Amazon Web Services resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.FMS.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallAssociationStatusCmdlet"> <summary> The onboarding status of a Firewall Manager admin account to third-party firewall vendor tenant. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallAssociationStatusCmdlet.ThirdPartyFirewall"> <summary> <para> <para>The name of the third-party firewall vendor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallAssociationStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetThirdPartyFirewallAssociationStatusResponse). Specifying the name of a property of type Amazon.FMS.Model.GetThirdPartyFirewallAssociationStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallAssociationStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThirdPartyFirewall parameter. The -PassThru parameter is deprecated, use -Select '^ThirdPartyFirewall' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet"> <summary> Retrieves a list of all of the third-party firewall policies that are associated with the third-party firewall administrator's account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet.ThirdPartyFirewall"> <summary> <para> <para>The name of the third-party firewall vendor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of third-party firewall policies that you want Firewall Manager to return. If the specified third-party firewall vendor is associated with more than <code>MaxResults</code> firewall policies, the response includes a <code>NextToken</code> element. <code>NextToken</code> contains an encrypted token that identifies the first third-party firewall policies that Firewall Manager will return if you submit another request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet.NextToken"> <summary> <para> <para>If the previous response included a <code>NextToken</code> element, the specified third-party firewall vendor is associated with more third-party firewall policies. To get more third-party firewall policies, submit another <code>ListThirdPartyFirewallFirewallPoliciesRequest</code> request.</para><para> For the value of <code>NextToken</code>, specify the value of <code>NextToken</code> from the previous response. If the previous response didn't include a <code>NextToken</code> element, there are no more third-party firewall policies to get. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThirdPartyFirewallFirewallPolicies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.ListThirdPartyFirewallFirewallPoliciesResponse). Specifying the name of a property of type Amazon.FMS.Model.ListThirdPartyFirewallFirewallPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThirdPartyFirewall parameter. The -PassThru parameter is deprecated, use -Select '^ThirdPartyFirewall' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSThirdPartyFirewallFirewallPolicyListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet"> <summary> Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet.MemberAccount"> <summary> <para> <para>The Amazon Web Services account ID that you want the details for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet.PolicyId"> <summary> <para> <para>The ID of the Firewall Manager policy that you want the details for. This currently only supports security group content audit policies.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet.ResourceId"> <summary> <para> <para>The ID of the resource that has violations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet.ResourceType"> <summary> <para> <para>The resource type. This is in the format shown in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types Reference</a>. Supported resource types are: <code>AWS::EC2::Instance</code>, <code>AWS::EC2::NetworkInterface</code>, <code>AWS::EC2::SecurityGroup</code>, <code>AWS::NetworkFirewall::FirewallPolicy</code>, and <code>AWS::EC2::Subnet</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ViolationDetail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.GetViolationDetailsResponse). Specifying the name of a property of type Amazon.FMS.Model.GetViolationDetailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSViolationDetailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RegisterFMSThirdPartyFirewallCmdlet"> <summary> Sets the Firewall Manager policy administrator as a tenant administrator of a third-party firewall service. A tenant is an instance of the third-party firewall service that's associated with your Amazon Web Services customer account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RegisterFMSThirdPartyFirewallCmdlet.ThirdPartyFirewall"> <summary> <para> <para>The name of the third-party firewall vendor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RegisterFMSThirdPartyFirewallCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThirdPartyFirewallStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.AssociateThirdPartyFirewallResponse). Specifying the name of a property of type Amazon.FMS.Model.AssociateThirdPartyFirewallResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RegisterFMSThirdPartyFirewallCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThirdPartyFirewall parameter. The -PassThru parameter is deprecated, use -Select '^ThirdPartyFirewall' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RegisterFMSThirdPartyFirewallCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAdminAccountAssociationCmdlet"> <summary> Disassociates the account that has been set as the Firewall Manager administrator account. To set a different account as the administrator account, you must submit an <code>AssociateAdminAccount</code> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAdminAccountAssociationCmdlet.Select"> <summary> 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.DisassociateAdminAccountResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAdminAccountAssociationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAppListCmdlet"> <summary> Permanently deletes an Firewall Manager applications list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAppListCmdlet.ListId"> <summary> <para> <para>The ID of the applications list that you want to delete. You can retrieve this ID from <code>PutAppsList</code>, <code>ListAppsLists</code>, and <code>GetAppsList</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAppListCmdlet.Select"> <summary> 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.DeleteAppsListResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAppListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListId parameter. The -PassThru parameter is deprecated, use -Select '^ListId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAppListCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSNotificationChannelCmdlet"> <summary> Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record Firewall Manager SNS logs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSNotificationChannelCmdlet.Select"> <summary> 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.DeleteNotificationChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSNotificationChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet"> <summary> Permanently deletes an Firewall Manager policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet.DeleteAllPolicyResource"> <summary> <para> <para>If <code>True</code>, the request performs cleanup according to the policy type. </para><para>For WAF and Shield Advanced policies, the cleanup does the following:</para><ul><li><para>Deletes rule groups created by Firewall Manager</para></li><li><para>Removes web ACLs from in-scope resources</para></li><li><para>Deletes web ACLs that contain no rules or rule groups</para></li></ul><para>For security group policies, the cleanup does the following for each security group in the policy:</para><ul><li><para>Disassociates the security group from in-scope resources </para></li><li><para>Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy</para></li></ul><para>After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet.PolicyId"> <summary> <para> <para>The ID of the policy that you want to delete. You can retrieve this ID from <code>PutPolicy</code> and <code>ListPolicies</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet.Select"> <summary> 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.DeletePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSProtocolListCmdlet"> <summary> Permanently deletes an Firewall Manager protocols list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSProtocolListCmdlet.ListId"> <summary> <para> <para>The ID of the protocols list that you want to delete. You can retrieve this ID from <code>PutProtocolsList</code>, <code>ListProtocolsLists</code>, and <code>GetProtocolsLost</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSProtocolListCmdlet.Select"> <summary> 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.DeleteProtocolsListResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSProtocolListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ListId parameter. The -PassThru parameter is deprecated, use -Select '^ListId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSProtocolListCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSResourceTagCmdlet"> <summary> Removes one or more tags from an Amazon Web Services resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager resources that support tagging are policies, applications lists, and protocols lists. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to remove from the resource. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSResourceTagCmdlet.Select"> <summary> 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.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.SetFMSPolicyCmdlet"> <summary> Creates an Firewall Manager policy. <para> Firewall Manager provides the following types of policies: </para><ul><li><para> An WAF policy (type WAFV2), which defines rule groups to run first in the corresponding WAF web ACL and rule groups to run last in the web ACL. </para></li><li><para> An WAF Classic policy (type WAF), which defines a rule group. </para></li><li><para> A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources. </para></li><li><para> A security group policy, which manages VPC security groups across your Amazon Web Services organization. </para></li><li><para> An Network Firewall policy, which provides firewall rules to filter network traffic in specified Amazon VPCs. </para></li><li><para> A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for specified VPCs. </para></li></ul><para> Each policy is specific to one of the types. If you want to enforce more than one policy type across accounts, create multiple policies. You can create multiple policies for each type. </para><para> You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see <a href="https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html">CreateSubscription</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.SetFMSPolicyCmdlet.Policy"> <summary> <para> <para>The details of the Firewall Manager policy to be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.SetFMSPolicyCmdlet.TagList"> <summary> <para> <para>The tags to add to the Amazon Web Services resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.SetFMSPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.PutPolicyResponse). Specifying the name of a property of type Amazon.FMS.Model.PutPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.SetFMSPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Policy parameter. The -PassThru parameter is deprecated, use -Select '^Policy' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.SetFMSPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.UnregisterFMSThirdPartyFirewallCmdlet"> <summary> Disassociates a Firewall Manager policy administrator from a third-party firewall tenant. When you call <code>DisassociateThirdPartyFirewall</code>, the third-party firewall vendor deletes all of the firewalls that are associated with the account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.UnregisterFMSThirdPartyFirewallCmdlet.ThirdPartyFirewall"> <summary> <para> <para>The name of the third-party firewall vendor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.UnregisterFMSThirdPartyFirewallCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ThirdPartyFirewallStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.DisassociateThirdPartyFirewallResponse). Specifying the name of a property of type Amazon.FMS.Model.DisassociateThirdPartyFirewallResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.UnregisterFMSThirdPartyFirewallCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ThirdPartyFirewall parameter. The -PassThru parameter is deprecated, use -Select '^ThirdPartyFirewall' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.UnregisterFMSThirdPartyFirewallCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet"> <summary> Creates an Firewall Manager applications list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_AppsList"> <summary> <para> <para>An array of applications in the Firewall Manager applications list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_CreateTime"> <summary> <para> <para>The time that the Firewall Manager applications list was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_LastUpdateTime"> <summary> <para> <para>The time that the Firewall Manager applications list was last updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_ListId"> <summary> <para> <para>The ID of the Firewall Manager applications list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_ListName"> <summary> <para> <para>The name of the Firewall Manager applications list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_ListUpdateToken"> <summary> <para> <para>A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.AppsList_PreviousAppsList"> <summary> <para> <para>A map of previous version numbers to their corresponding <code>App</code> object arrays.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.TagList"> <summary> <para> <para>The tags associated with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.PutAppsListResponse). Specifying the name of a property of type Amazon.FMS.Model.PutAppsListResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AppsList_ListName parameter. The -PassThru parameter is deprecated, use -Select '^AppsList_ListName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSAppListCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet"> <summary> Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager uses to record SNS logs. <para> To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager role <code>AWSServiceRoleForFMS</code> to publish SNS logs. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions for API actions</a> in the <i>Firewall Manager Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet.SnsRoleName"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record Firewall Manager activity. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet.SnsTopicArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the SNS topic that collects notifications from Firewall Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet.Select"> <summary> 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.PutNotificationChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SnsTopicArn parameter. The -PassThru parameter is deprecated, use -Select '^SnsTopicArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet"> <summary> Creates an Firewall Manager protocols list. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_CreateTime"> <summary> <para> <para>The time that the Firewall Manager protocols list was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_LastUpdateTime"> <summary> <para> <para>The time that the Firewall Manager protocols list was last updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_ListId"> <summary> <para> <para>The ID of the Firewall Manager protocols list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_ListName"> <summary> <para> <para>The name of the Firewall Manager protocols list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_ListUpdateToken"> <summary> <para> <para>A unique identifier for each update to the list. When you update the list, the update token must match the token of the current version of the application list. You can retrieve the update token by getting the list. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_PreviousProtocolsList"> <summary> <para> <para>A map of previous version numbers to their corresponding protocol arrays.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.ProtocolsList_ProtocolsList"> <summary> <para> <para>An array of protocols in the Firewall Manager protocols list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.TagList"> <summary> <para> <para>The tags associated with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.FMS.Model.PutProtocolsListResponse). Specifying the name of a property of type Amazon.FMS.Model.PutProtocolsListResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProtocolsList_ListName parameter. The -PassThru parameter is deprecated, use -Select '^ProtocolsList_ListName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSProtocolListCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |