software.amazon.awssdk.services.fms.model

Class PolicyComplianceDetail

java.lang.Object

software.amazon.awssdk.services.fms.model.PolicyComplianceDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PolicyComplianceDetail.Builder,PolicyComplianceDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class PolicyComplianceDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PolicyComplianceDetail.Builder,PolicyComplianceDetail>

Describes the noncompliant resources in a member account for a specific Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded is set to True.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PolicyComplianceDetail.Builder

Method Summary

Modifier and Type	Method and Description
static PolicyComplianceDetail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	evaluationLimitExceeded() Indicates if over 100 resources are noncompliant with the Firewall Manager policy.
Instant	expiredAt() A timestamp that indicates when the returned information should be considered out of date.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIssueInfoMap() For responses, this returns true if the service returned a value for the IssueInfoMap property.
boolean	hasViolators() For responses, this returns true if the service returned a value for the Violators property.
Map<DependentServiceName,String>	issueInfoMap() Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.
Map<String,String>	issueInfoMapAsStrings() Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.
String	memberAccount() The Amazon Web Services account ID.
String	policyId() The ID of the Firewall Manager policy.
String	policyOwner() The Amazon Web Services account that created the Firewall Manager policy.
List<SdkField<?>>	sdkFields()
static Class<? extends PolicyComplianceDetail.Builder>	serializableBuilderClass()
PolicyComplianceDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<ComplianceViolator>	violators() An array of resources that aren't protected by the WAF or Shield Advanced policy or that aren't in compliance with the security group policy.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

policyOwner

public final String policyOwner()

The Amazon Web Services account that created the Firewall Manager policy.

Returns:

The Amazon Web Services account that created the Firewall Manager policy.

policyId

public final String policyId()

The ID of the Firewall Manager policy.

Returns:

The ID of the Firewall Manager policy.

memberAccount

public final String memberAccount()

The Amazon Web Services account ID.

Returns:

The Amazon Web Services account ID.

hasViolators

public final boolean hasViolators()

For responses, this returns true if the service returned a value for the Violators property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

violators

public final List<ComplianceViolator> violators()

An array of resources that aren't protected by the WAF or Shield Advanced policy or that aren't in compliance with the security group policy.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasViolators() method.

Returns:

An array of resources that aren't protected by the WAF or Shield Advanced policy or that aren't in compliance with the security group policy.

evaluationLimitExceeded

public final Boolean evaluationLimitExceeded()

Indicates if over 100 resources are noncompliant with the Firewall Manager policy.

Returns:

Indicates if over 100 resources are noncompliant with the Firewall Manager policy.

expiredAt

public final Instant expiredAt()

A timestamp that indicates when the returned information should be considered out of date.

Returns:

A timestamp that indicates when the returned information should be considered out of date.

issueInfoMap

public final Map<DependentServiceName,String> issueInfoMap()

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssueInfoMap() method.

Returns:

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

hasIssueInfoMap

public final boolean hasIssueInfoMap()

For responses, this returns true if the service returned a value for the IssueInfoMap property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

issueInfoMapAsStrings

public final Map<String,String> issueInfoMapAsStrings()

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIssueInfoMap() method.

Returns:

Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

toBuilder

public PolicyComplianceDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PolicyComplianceDetail.Builder,PolicyComplianceDetail>

builder

public static PolicyComplianceDetail.Builder builder()

serializableBuilderClass

public static Class<? extends PolicyComplianceDetail.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo