Interface PolicySummary.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PolicySummary.Builder,
,PolicySummary> SdkBuilder<PolicySummary.Builder,
,PolicySummary> SdkPojo
- Enclosing class:
PolicySummary
-
Method Summary
Modifier and TypeMethodDescriptiondeleteUnusedFMManagedResources
(Boolean deleteUnusedFMManagedResources) Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope.The Amazon Resource Name (ARN) of the specified policy.The ID of the specified policy.policyName
(String policyName) The name of the specified policy.policyStatus
(String policyStatus) Indicates whether the policy is in or out of an admin's policy or Region scope.policyStatus
(CustomerPolicyStatus policyStatus) Indicates whether the policy is in or out of an admin's policy or Region scope.remediationEnabled
(Boolean remediationEnabled) Indicates if the policy should be automatically applied to new resources.resourceType
(String resourceType) The type of resource protected by or in scope of the policy.securityServiceType
(String securityServiceType) The service that the policy is using to protect the resources.securityServiceType
(SecurityServiceType securityServiceType) The service that the policy is using to protect the resources.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
policyArn
The Amazon Resource Name (ARN) of the specified policy.
- Parameters:
policyArn
- The Amazon Resource Name (ARN) of the specified policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyId
The ID of the specified policy.
- Parameters:
policyId
- The ID of the specified policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyName
The name of the specified policy.
- Parameters:
policyName
- The name of the specified policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceType
The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. For WAF and Shield Advanced, examples include
AWS::ElasticLoadBalancingV2::LoadBalancer
andAWS::CloudFront::Distribution
. For a security group common policy, valid values areAWS::EC2::NetworkInterface
andAWS::EC2::Instance
. For a security group content audit policy, valid values areAWS::EC2::SecurityGroup
,AWS::EC2::NetworkInterface
, andAWS::EC2::Instance
. For a security group usage audit policy, the value isAWS::EC2::SecurityGroup
. For an Network Firewall policy or DNS Firewall policy, the value isAWS::EC2::VPC
.- Parameters:
resourceType
- The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. For WAF and Shield Advanced, examples includeAWS::ElasticLoadBalancingV2::LoadBalancer
andAWS::CloudFront::Distribution
. For a security group common policy, valid values areAWS::EC2::NetworkInterface
andAWS::EC2::Instance
. For a security group content audit policy, valid values areAWS::EC2::SecurityGroup
,AWS::EC2::NetworkInterface
, andAWS::EC2::Instance
. For a security group usage audit policy, the value isAWS::EC2::SecurityGroup
. For an Network Firewall policy or DNS Firewall policy, the value isAWS::EC2::VPC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityServiceType
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
- Parameters:
securityServiceType
- The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
securityServiceType
The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.
- Parameters:
securityServiceType
- The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
remediationEnabled
Indicates if the policy should be automatically applied to new resources.
- Parameters:
remediationEnabled
- Indicates if the policy should be automatically applied to new resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleteUnusedFMManagedResources
Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.
By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic policies.
- Parameters:
deleteUnusedFMManagedResources
- Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.By default, Firewall Manager doesn't remove protections or delete Firewall Manager managed resources.
This option is not available for Shield Advanced or WAF Classic policies.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyStatus
Indicates whether the policy is in or out of an admin's policy or Region scope.
-
ACTIVE
- The administrator can manage and delete the policy. -
OUT_OF_ADMIN_SCOPE
- The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
- Parameters:
policyStatus
- Indicates whether the policy is in or out of an admin's policy or Region scope.-
ACTIVE
- The administrator can manage and delete the policy. -
OUT_OF_ADMIN_SCOPE
- The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
policyStatus
Indicates whether the policy is in or out of an admin's policy or Region scope.
-
ACTIVE
- The administrator can manage and delete the policy. -
OUT_OF_ADMIN_SCOPE
- The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
- Parameters:
policyStatus
- Indicates whether the policy is in or out of an admin's policy or Region scope.-
ACTIVE
- The administrator can manage and delete the policy. -
OUT_OF_ADMIN_SCOPE
- The administrator can view the policy, but they can't edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won't be protected.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-