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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SecurityGroup.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SecurityGroup.Builder
builder()
String
description()
A description of the security group.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
String
groupId()
The ID of the security group.String
groupName()
The name of the security group.int
hashCode()
boolean
hasIpPermissions()
For responses, this returns true if the service returned a value for the IpPermissions property.boolean
hasIpPermissionsEgress()
For responses, this returns true if the service returned a value for the IpPermissionsEgress property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.List<IpPermission>
ipPermissions()
The inbound rules associated with the security group.List<IpPermission>
ipPermissionsEgress()
The outbound rules associated with the security group.String
ownerId()
The Amazon Web Services account ID of the owner of the security group.List<SdkField<?>>
sdkFields()
static Class<? extends SecurityGroup.Builder>
serializableBuilderClass()
List<Tag>
tags()
Any tags assigned to the security group.SecurityGroup.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
vpcId()
The ID of the VPC for the security group.-
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
-
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 theisEmpty()
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 theisEmpty()
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 theisEmpty()
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SecurityGroup.Builder,SecurityGroup>
-
builder
public static SecurityGroup.Builder builder()
-
serializableBuilderClass
public static Class<? extends SecurityGroup.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-