Class ResourceCoverageSummary

java.lang.Object
software.amazon.awssdk.services.networksecuritymanager.model.ResourceCoverageSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ResourceCoverageSummary.Builder,ResourceCoverageSummary>

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

Describes how an AWS Network Security Manager entity covers a protected resource.

See Also:
  • Method Details

    • resourceArn

      public final String resourceArn()

      The Amazon Resource Name (ARN) of the protected resource.

      Returns:
      The Amazon Resource Name (ARN) of the protected resource.
    • entityType

      public final ServiceResourceType entityType()

      The type of the entity that covers the resource, such as Policy.

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

      Returns:
      The type of the entity that covers the resource, such as Policy.
      See Also:
    • entityTypeAsString

      public final String entityTypeAsString()

      The type of the entity that covers the resource, such as Policy.

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

      Returns:
      The type of the entity that covers the resource, such as Policy.
      See Also:
    • entityArn

      public final String entityArn()

      The Amazon Resource Name (ARN) of the entity that covers the resource.

      Returns:
      The Amazon Resource Name (ARN) of the entity that covers the resource.
    • resourceOwnerAccountId

      public final String resourceOwnerAccountId()

      The AWS account ID that owns the protected resource. This can differ from the account that owns the entity.

      Returns:
      The AWS account ID that owns the protected resource. This can differ from the account that owns the entity.
    • resourceType

      public final ScopeResourceType resourceType()

      The type of the protected resource, in AWS CloudFormation format.

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

      Returns:
      The type of the protected resource, in AWS CloudFormation format.
      See Also:
    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of the protected resource, in AWS CloudFormation format.

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

      Returns:
      The type of the protected resource, in AWS CloudFormation format.
      See Also:
    • firewallType

      public final PolicyFirewallType firewallType()

      The firewall type of the policy that covers the resource. This is present when entityType is Policy.

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

      Returns:
      The firewall type of the policy that covers the resource. This is present when entityType is Policy.
      See Also:
    • firewallTypeAsString

      public final String firewallTypeAsString()

      The firewall type of the policy that covers the resource. This is present when entityType is Policy.

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

      Returns:
      The firewall type of the policy that covers the resource. This is present when entityType is Policy.
      See Also:
    • coverageStatus

      public final CoverageStatus coverageStatus()

      Specifies whether the entity contributes to the effective configuration of the resource for its firewall type. For firewall types that combine policies, such as AWS WAF and AWS Shield Advanced, every policy that covers the resource is IN_EFFECT. For firewall types that apply a single policy, only the highest-priority policy is IN_EFFECT and the others are SUPERSEDED.

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

      Returns:
      Specifies whether the entity contributes to the effective configuration of the resource for its firewall type. For firewall types that combine policies, such as AWS WAF and AWS Shield Advanced, every policy that covers the resource is IN_EFFECT. For firewall types that apply a single policy, only the highest-priority policy is IN_EFFECT and the others are SUPERSEDED.
      See Also:
    • coverageStatusAsString

      public final String coverageStatusAsString()

      Specifies whether the entity contributes to the effective configuration of the resource for its firewall type. For firewall types that combine policies, such as AWS WAF and AWS Shield Advanced, every policy that covers the resource is IN_EFFECT. For firewall types that apply a single policy, only the highest-priority policy is IN_EFFECT and the others are SUPERSEDED.

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

      Returns:
      Specifies whether the entity contributes to the effective configuration of the resource for its firewall type. For firewall types that combine policies, such as AWS WAF and AWS Shield Advanced, every policy that covers the resource is IN_EFFECT. For firewall types that apply a single policy, only the highest-priority policy is IN_EFFECT and the others are SUPERSEDED.
      See Also:
    • hasDeploymentArns

      public final boolean hasDeploymentArns()
      For responses, this returns true if the service returned a value for the DeploymentArns 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.
    • deploymentArns

      public final List<String> deploymentArns()

      The Amazon Resource Names (ARNs) of the deployments through which the entity covers the resource.

      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 hasDeploymentArns() method.

      Returns:
      The Amazon Resource Names (ARNs) of the deployments through which the entity covers the resource.
    • updatedAt

      public final Instant updatedAt()

      The time when AWS Network Security Manager last evaluated the coverage.

      Returns:
      The time when AWS Network Security Manager last evaluated the coverage.
    • toBuilder

      public ResourceCoverageSummary.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<ResourceCoverageSummary.Builder,ResourceCoverageSummary>
      Returns:
      a builder for type T
    • builder

      public static ResourceCoverageSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ResourceCoverageSummary.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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.