software.amazon.awssdk.services.fms.model

Class PolicySummary

java.lang.Object

software.amazon.awssdk.services.fms.model.PolicySummary

All Implemented Interfaces:

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

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

Details of the AWS Firewall Manager policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PolicySummary.Builder

Method Summary

Modifier and Type	Method and Description
static PolicySummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	policyArn() The Amazon Resource Name (ARN) of the specified policy.
String	policyId() The ID of the specified policy.
String	policyName() The name of the specified policy.
Boolean	remediationEnabled() Indicates if the policy should be automatically applied to new resources.
String	resourceType() The type of resource protected by or in scope of the policy.
List<SdkField<?>>	sdkFields()
SecurityServiceType	securityServiceType() The service that the policy is using to protect the resources.
String	securityServiceTypeAsString() The service that the policy is using to protect the resources.
static Class<? extends PolicySummary.Builder>	serializableBuilderClass()
PolicySummary.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

policyArn

public final String policyArn()

The Amazon Resource Name (ARN) of the specified policy.

Returns:

The Amazon Resource Name (ARN) of the specified policy.

policyId

public final String policyId()

The ID of the specified policy.

Returns:

The ID of the specified policy.

policyName

public final String policyName()

The name of the specified policy.

Returns:

The name of the specified policy.

resourceType

public final String resourceType()

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer 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 AWS Network Firewall policy, the value is AWS::EC2::VPC .

Returns:

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer 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 AWS Network Firewall policy, the value is AWS::EC2::VPC.

securityServiceType

public final SecurityServiceType securityServiceType()

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

If the service returns an enum value that is not available in the current SDK version, securityServiceType will return SecurityServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityServiceTypeAsString().

Returns:

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

See Also:

SecurityServiceType

securityServiceTypeAsString

public final String securityServiceTypeAsString()

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

If the service returns an enum value that is not available in the current SDK version, securityServiceType will return SecurityServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityServiceTypeAsString().

Returns:

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

See Also:

SecurityServiceType

remediationEnabled

public final Boolean remediationEnabled()

Indicates if the policy should be automatically applied to new resources.

Returns:

Indicates if the policy should be automatically applied to new resources.

toBuilder

public PolicySummary.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PolicySummary.Builder,PolicySummary>

Returns:

a builder for type T

builder

public static PolicySummary.Builder builder()

serializableBuilderClass

public static Class<? extends PolicySummary.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.