Class RevokeSecurityGroupIngressRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.RevokeSecurityGroupIngressRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<RevokeSecurityGroupIngressRequest.Builder,RevokeSecurityGroupIngressRequest>
@Generated("software.amazon.awssdk:codegen") public final class RevokeSecurityGroupIngressRequest extends Ec2Request implements ToCopyableBuilder<RevokeSecurityGroupIngressRequest.Builder,RevokeSecurityGroupIngressRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
RevokeSecurityGroupIngressRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RevokeSecurityGroupIngressRequest.Builder
builder()
String
cidrIp()
The CIDR IP address range.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Integer
fromPort()
If the protocol is TCP or UDP, this is the start of the port range.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
String
groupId()
The ID of the security group.String
groupName()
[Default VPC] 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
hasSecurityGroupRuleIds()
For responses, this returns true if the service returned a value for the SecurityGroupRuleIds property.List<IpPermission>
ipPermissions()
The sets of IP permissions.String
ipProtocol()
List<SdkField<?>>
sdkFields()
List<String>
securityGroupRuleIds()
The IDs of the security group rules.static Class<? extends RevokeSecurityGroupIngressRequest.Builder>
serializableBuilderClass()
String
sourceSecurityGroupName()
[Default VPC] The name of the source security group.String
sourceSecurityGroupOwnerId()
Not supported.RevokeSecurityGroupIngressRequest.Builder
toBuilder()
Integer
toPort()
If the protocol is TCP or UDP, this is the end of the port range.String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
cidrIp
public final String cidrIp()
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
- Returns:
- The CIDR IP address range. You can't specify this parameter when specifying a source security group.
-
fromPort
public final Integer fromPort()
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.
- Returns:
- If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.
-
groupId
public final String groupId()
The ID of the security group.
- Returns:
- The ID of the security group.
-
groupName
public final String groupName()
[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
- Returns:
- [Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.
-
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 sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
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 sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
-
ipProtocol
public final String ipProtocol()
The IP protocol name (
tcp
,udp
,icmp
) or number (see Protocol Numbers). Use-1
to specify all.- Returns:
- The IP protocol name (
tcp
,udp
,icmp
) or number (see Protocol Numbers). Use-1
to specify all.
-
sourceSecurityGroupName
public final String sourceSecurityGroupName()
[Default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
- Returns:
- [Default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
-
sourceSecurityGroupOwnerId
public final String sourceSecurityGroupOwnerId()
Not supported.
- Returns:
- Not supported.
-
toPort
public final Integer toPort()
If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.
- Returns:
- If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
hasSecurityGroupRuleIds
public final boolean hasSecurityGroupRuleIds()
For responses, this returns true if the service returned a value for the SecurityGroupRuleIds 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.
-
securityGroupRuleIds
public final List<String> securityGroupRuleIds()
The IDs of the security group rules.
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
hasSecurityGroupRuleIds()
method.- Returns:
- The IDs of the security group rules.
-
toBuilder
public RevokeSecurityGroupIngressRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<RevokeSecurityGroupIngressRequest.Builder,RevokeSecurityGroupIngressRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static RevokeSecurityGroupIngressRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends RevokeSecurityGroupIngressRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-