Package software.amazon.awssdk.services.ec2.model

Class SecurityGroup

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

Describes a security group.

See Also:

  • Method Details

    • description

      public final String description()

      A description of the security group.

      Returns:
      A description of the security group.

    • groupName

      public final String groupName()

      The name of the security group.

      Returns:
      The name of the security group.

    • hasIpPermissions

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

    • ipPermissions

      public final List<IpPermission> ipPermissions()

      The inbound rules associated with the security group.

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

      Returns:
      The inbound rules associated with the security group.

    • ownerId

      public final String ownerId()

      The Amazon Web Services account ID of the owner of the security group.

      Returns:
      The Amazon Web Services account ID of the owner of the security group.

    • groupId

      public final String groupId()

      The ID of the security group.

      Returns:
      The ID of the security group.

    • hasIpPermissionsEgress

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

    • ipPermissionsEgress

      public final List<IpPermission> ipPermissionsEgress()

      The outbound rules associated with the security group.

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

      Returns:
      The outbound rules associated with the security group.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Any tags assigned to the security group.

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

      Returns:
      Any tags assigned to the security group.

    • vpcId

      public final String vpcId()

      The ID of the VPC for the security group.

      Returns:
      The ID of the VPC for the security group.

    • toBuilder

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

    • builder

      public static SecurityGroup.Builder builder()

    • serializableBuilderClass

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