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 AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account. <para> The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet.AdminAccount"> <summary> <para> <para>The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html">Managing the AWS Accounts in Your Organization</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.AddFMSAdminAccountAssociationCmdlet.PassThru"> <summary> Returns the value passed to the AdminAccount parameter. By default, this cmdlet does not generate any output. </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.GetFMSAdminAccountCmdlet"> <summary> Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator. </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. Resources are considered non-compliant if the specified policy has not been applied to them. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceDetailCmdlet.MemberAccount"> <summary> <para> <para>The AWS 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="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet"> <summary> Returns an array of <code>PolicyComplianceStatus</code> objects in the response. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected by the specified policy.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSComplianceStatusListCmdlet.PolicyId"> <summary> <para> <para>The ID of the AWS 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 AWS 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> </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>, AWS 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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 AWS organization. <para> The <code>ListMemberAccounts</code> must be submitted by the account that is set as the AWS Firewall Manager administrator. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSMemberAccountListCmdlet.MaxResult"> <summary> <para> <para>Specifies the number of member account IDs that you want AWS 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> </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>, AWS 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSNotificationChannelCmdlet"> <summary> Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyCmdlet"> <summary> Returns information about the specified AWS Firewall Manager policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyCmdlet.PolicyId"> <summary> <para> <para>The ID of the AWS Firewall Manager policy that you want the details for.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.GetFMSPolicyListCmdlet"> <summary> Returns an array of <code>PolicySummary</code> objects in the response.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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 AWS 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> </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>, AWS 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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </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. </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 sample request above indicates a number type because the default used by AWS 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 AWS 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 sample request above indicates a number type because the default used by AWS 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 AWS 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>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list 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> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSAdminAccountAssociationCmdlet"> <summary> Disassociates the account that has been set as the AWS 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.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 AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs. </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 AWS Firewall Manager policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.RemoveFMSPolicyCmdlet.DeleteAllPolicyResource"> <summary> <para> <para>If <code>True</code>, the request will also perform a clean-up process that will:</para><ul><li><para>Delete rule groups created by AWS Firewall Manager</para></li><li><para>Remove web ACLs from in-scope resources</para></li><li><para>Delete web ACLs that contain no rules or rule groups</para></li></ul><para>After the cleanup, in-scope resources will no longer be protected by web ACLs in this policy. Protection of out-of-scope resources will remain unchanged. Scope is determined by tags and accounts associated with the policy. When creating the policy, if you specified that only resources in specific accounts or with specific tags be protected by the policy, those resources are in-scope. All others are out of scope. If you did not 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. <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.RemoveFMSPolicyCmdlet.PassThru"> <summary> Returns the value passed to the PolicyId parameter. By default, this cmdlet does not generate any output. </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.SetFMSPolicyCmdlet"> <summary> Creates an AWS Firewall Manager policy. <para> Firewall Manager provides two types of policies: A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources, or a WAF policy, which contains a rule group and defines which resources are to be protected by that rule group. A policy is specific to either WAF or Shield Advanced. If you want to enforce both WAF rules and Shield Advanced protection across accounts, you can create multiple policies. You can create one or more policies for WAF rules, and one or more policies for Shield Advanced. </para><para> You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information on 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 AWS Firewall Manager policy to be created.</para> </para> </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.WriteFMSNotificationChannelCmdlet"> <summary> Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs. </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 AWS 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 AWS Firewall Manager.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.FMS.WriteFMSNotificationChannelCmdlet.PassThru"> <summary> Returns the value passed to the SnsTopicArn parameter. By default, this cmdlet does not generate any output. </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> </members> </doc> |