public static interface Policy.Builder extends SdkPojo, CopyableBuilder<Policy.Builder,Policy>
| Modifier and Type | Method and Description |
|---|---|
Policy.Builder |
deleteUnusedFMManagedResources(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.
|
Policy.Builder |
excludeMap(Map<CustomerPolicyScopeIdType,? extends Collection<String>> excludeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from
the policy.
|
Policy.Builder |
excludeMapWithStrings(Map<String,? extends Collection<String>> excludeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from
the policy.
|
Policy.Builder |
excludeResourceTags(Boolean excludeResourceTags)
If set to
True, resources with the tags that are specified in the ResourceTag array
are not in scope of the policy. |
Policy.Builder |
includeMap(Map<CustomerPolicyScopeIdType,? extends Collection<String>> includeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the
policy.
|
Policy.Builder |
includeMapWithStrings(Map<String,? extends Collection<String>> includeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the
policy.
|
Policy.Builder |
policyDescription(String policyDescription)
The definition of the Network Firewall firewall policy.
|
Policy.Builder |
policyId(String policyId)
The ID of the Firewall Manager policy.
|
Policy.Builder |
policyName(String policyName)
The name of the Firewall Manager policy.
|
Policy.Builder |
policyStatus(CustomerPolicyStatus policyStatus)
Indicates whether the policy is in or out of an admin's policy or Region scope.
|
Policy.Builder |
policyStatus(String policyStatus)
Indicates whether the policy is in or out of an admin's policy or Region scope.
|
Policy.Builder |
policyUpdateToken(String policyUpdateToken)
A unique identifier for each update to the policy.
|
Policy.Builder |
remediationEnabled(Boolean remediationEnabled)
Indicates if the policy should be automatically applied to new resources.
|
Policy.Builder |
resourceSetIds(Collection<String> resourceSetIds)
The unique identifiers of the resource sets used by the policy.
|
Policy.Builder |
resourceSetIds(String... resourceSetIds)
The unique identifiers of the resource sets used by the policy.
|
Policy.Builder |
resourceTags(Collection<ResourceTag> resourceTags)
An array of
ResourceTag objects. |
Policy.Builder |
resourceTags(Consumer<ResourceTag.Builder>... resourceTags)
An array of
ResourceTag objects. |
Policy.Builder |
resourceTags(ResourceTag... resourceTags)
An array of
ResourceTag objects. |
Policy.Builder |
resourceType(String resourceType)
The type of resource protected by or in scope of the policy.
|
Policy.Builder |
resourceTypeList(Collection<String> resourceTypeList)
An array of
ResourceType objects. |
Policy.Builder |
resourceTypeList(String... resourceTypeList)
An array of
ResourceType objects. |
default Policy.Builder |
securityServicePolicyData(Consumer<SecurityServicePolicyData.Builder> securityServicePolicyData)
Details about the security service that is being used to protect the resources.
|
Policy.Builder |
securityServicePolicyData(SecurityServicePolicyData securityServicePolicyData)
Details about the security service that is being used to protect the resources.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildPolicy.Builder policyId(String policyId)
The ID of the Firewall Manager policy.
policyId - The ID of the Firewall Manager policy.Policy.Builder policyName(String policyName)
The name of the Firewall Manager policy.
policyName - The name of the Firewall Manager policy.Policy.Builder policyUpdateToken(String policyUpdateToken)
A unique identifier for each update to the policy. When issuing a PutPolicy request, the
PolicyUpdateToken in the request must match the PolicyUpdateToken of the current
policy version. To get the PolicyUpdateToken of the current policy version, use a
GetPolicy request.
policyUpdateToken - A unique identifier for each update to the policy. When issuing a PutPolicy request, the
PolicyUpdateToken in the request must match the PolicyUpdateToken of the
current policy version. To get the PolicyUpdateToken of the current policy version, use a
GetPolicy request.Policy.Builder securityServicePolicyData(SecurityServicePolicyData securityServicePolicyData)
Details about the security service that is being used to protect the resources.
securityServicePolicyData - Details about the security service that is being used to protect the resources.default Policy.Builder securityServicePolicyData(Consumer<SecurityServicePolicyData.Builder> securityServicePolicyData)
Details about the security service that is being used to protect the resources.
This is a convenience method that creates an instance of theSecurityServicePolicyData.Builder
avoiding the need to create one manually via SecurityServicePolicyData.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to securityServicePolicyData(SecurityServicePolicyData).
securityServicePolicyData - a consumer that will call methods on SecurityServicePolicyData.BuildersecurityServicePolicyData(SecurityServicePolicyData)Policy.Builder resourceType(String 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. To apply this policy to multiple resource types, specify a
resource type of ResourceTypeList and then specify the resource types in a
ResourceTypeList.
For WAF and Shield Advanced, resource types include AWS::ElasticLoadBalancingV2::LoadBalancer,
AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and
AWS::CloudFront::Distribution. For a security group common policy, valid values are
AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content
audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface,
and AWS::EC2::Instance. For a security group usage audit policy, the value is
AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy, the value is
AWS::EC2::VPC.
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. To apply this policy to multiple resource types,
specify a resource type of ResourceTypeList and then specify the resource types in a
ResourceTypeList.
For WAF and Shield Advanced, resource types include
AWS::ElasticLoadBalancingV2::LoadBalancer,
AWS::ElasticLoadBalancing::LoadBalancer, AWS::EC2::EIP, and
AWS::CloudFront::Distribution. For a security group common policy, valid values are
AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group
content audit policy, valid values are AWS::EC2::SecurityGroup,
AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group
usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy
or DNS Firewall policy, the value is AWS::EC2::VPC.
Policy.Builder resourceTypeList(Collection<String> resourceTypeList)
An array of ResourceType objects. Use this only to specify multiple resource types. To specify a
single resource type, use ResourceType.
resourceTypeList - An array of ResourceType objects. Use this only to specify multiple resource types. To
specify a single resource type, use ResourceType.Policy.Builder resourceTypeList(String... resourceTypeList)
An array of ResourceType objects. Use this only to specify multiple resource types. To specify a
single resource type, use ResourceType.
resourceTypeList - An array of ResourceType objects. Use this only to specify multiple resource types. To
specify a single resource type, use ResourceType.Policy.Builder resourceTags(Collection<ResourceTag> resourceTags)
An array of ResourceTag objects.
resourceTags - An array of ResourceTag objects.Policy.Builder resourceTags(ResourceTag... resourceTags)
An array of ResourceTag objects.
resourceTags - An array of ResourceTag objects.Policy.Builder resourceTags(Consumer<ResourceTag.Builder>... resourceTags)
An array of ResourceTag objects.
ResourceTag.Builder avoiding the need to create one
manually via ResourceTag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #resourceTags(List.
resourceTags - a consumer that will call methods on
ResourceTag.Builder#resourceTags(java.util.Collection) Policy.Builder excludeResourceTags(Boolean excludeResourceTags)
If set to True, resources with the tags that are specified in the ResourceTag array
are not in scope of the policy. If set to False, and the ResourceTag array is not
null, only resources with the specified tags are in scope of the policy.
excludeResourceTags - If set to True, resources with the tags that are specified in the
ResourceTag array are not in scope of the policy. If set to False, and the
ResourceTag array is not null, only resources with the specified tags are in scope of the
policy.Policy.Builder remediationEnabled(Boolean remediationEnabled)
Indicates if the policy should be automatically applied to new resources.
remediationEnabled - Indicates if the policy should be automatically applied to new resources.Policy.Builder deleteUnusedFMManagedResources(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. 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.
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.
Policy.Builder includeMapWithStrings(Map<String,? extends Collection<String>> includeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall
Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate
any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall
Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a
valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
includeMap - Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include
in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of
its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap,
Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does
not evaluate any ExcludeMap specifications. If you do not specify an
IncludeMap, then Firewall Manager applies the policy to all accounts except for those
specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid
map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following
is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Policy.Builder includeMap(Map<CustomerPolicyScopeIdType,? extends Collection<String>> includeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall
Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate
any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall
Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a
valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
includeMap - Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to include
in the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of
its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap,
Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does
not evaluate any ExcludeMap specifications. If you do not specify an
IncludeMap, then Firewall Manager applies the policy to all accounts except for those
specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid
map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following
is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Policy.Builder excludeMapWithStrings(Map<String,? extends Collection<String>> excludeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall
Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate
any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall
Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a
valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
excludeMap - Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude
from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of
its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap,
Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does
not evaluate any ExcludeMap specifications. If you do not specify an
IncludeMap, then Firewall Manager applies the policy to all accounts except for those
specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid
map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following
is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Policy.Builder excludeMap(Map<CustomerPolicyScopeIdType,? extends Collection<String>> excludeMap)
Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap, Firewall
Manager applies the policy to all accounts specified by the IncludeMap, and does not evaluate
any ExcludeMap specifications. If you do not specify an IncludeMap, then Firewall
Manager applies the policy to all accounts except for those specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following is a
valid map: {“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
excludeMap - Specifies the Amazon Web Services account IDs and Organizations organizational units (OUs) to exclude
from the policy. Specifying an OU is the equivalent of specifying all accounts in the OU and in any of
its child OUs, including any child OUs and accounts that are added at a later time.
You can specify inclusions or exclusions, but not both. If you specify an IncludeMap,
Firewall Manager applies the policy to all accounts specified by the IncludeMap, and does
not evaluate any ExcludeMap specifications. If you do not specify an
IncludeMap, then Firewall Manager applies the policy to all accounts except for those
specified by the ExcludeMap.
You can specify account IDs, OUs, or a combination:
Specify account IDs by setting the key to ACCOUNT. For example, the following is a valid
map: {“ACCOUNT” : [“accountID1”, “accountID2”]}.
Specify OUs by setting the key to ORG_UNIT. For example, the following is a valid map:
{“ORG_UNIT” : [“ouid111”, “ouid112”]}.
Specify accounts and OUs together in a single map, separated with a comma. For example, the following
is a valid map:
{“ACCOUNT” : [“accountID1”, “accountID2”], “ORG_UNIT” : [“ouid111”, “ouid112”]}.
Policy.Builder resourceSetIds(Collection<String> resourceSetIds)
The unique identifiers of the resource sets used by the policy.
resourceSetIds - The unique identifiers of the resource sets used by the policy.Policy.Builder resourceSetIds(String... resourceSetIds)
The unique identifiers of the resource sets used by the policy.
resourceSetIds - The unique identifiers of the resource sets used by the policy.Policy.Builder policyDescription(String policyDescription)
The definition of the Network Firewall firewall policy.
policyDescription - The definition of the Network Firewall firewall policy.Policy.Builder policyStatus(String 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.
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.
CustomerPolicyStatus,
CustomerPolicyStatusPolicy.Builder policyStatus(CustomerPolicyStatus 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.
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.
CustomerPolicyStatus,
CustomerPolicyStatusCopyright © 2023. All rights reserved.