Class ScopeConfiguration

java.lang.Object
software.amazon.awssdk.services.networksecuritymanager.model.ScopeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScopeConfiguration.Builder,ScopeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ScopeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScopeConfiguration.Builder,ScopeConfiguration>

Defines which accounts and resources are in scope.

See Also:

  • Method Details

    • accountFilter

      public final AccountFilter accountFilter()

      The account filter that determines which accounts are in scope. When set, exactly one of includeAll, include, or exclude is set.

      Organization administrators must include an account filter in every scope configuration. Single-account administrators must omit it: a scope without an account filter applies only to the administrator's own account. The presence of an account filter is fixed when the scope is created: an update can't add an account filter to a scope that was created without one, or remove the account filter from a scope that was created with one.

      Returns:
      The account filter that determines which accounts are in scope. When set, exactly one of includeAll, include, or exclude is set.

      Organization administrators must include an account filter in every scope configuration. Single-account administrators must omit it: a scope without an account filter applies only to the administrator's own account. The presence of an account filter is fixed when the scope is created: an update can't add an account filter to a scope that was created without one, or remove the account filter from a scope that was created with one.

    • resourceScopes

      public final Map<ScopeResourceType,ResourceScope> resourceScopes()

      The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.

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

      Returns:
      The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.

    • hasResourceScopes

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

    • resourceScopesAsStrings

      public final Map<String,ResourceScope> resourceScopesAsStrings()

      The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.

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

      Returns:
      The resource-level scoping configuration, keyed by resource type, that defines which resources within the selected accounts are in scope.

    • toBuilder

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

    • builder

      public static ScopeConfiguration.Builder builder()

    • serializableBuilderClass

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