Class AuthorizeSecurityGroupIngressRequest
- 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.AuthorizeSecurityGroupIngressRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>
@Generated("software.amazon.awssdk:codegen") public final class AuthorizeSecurityGroupIngressRequest extends Ec2Request implements ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AuthorizeSecurityGroupIngressRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AuthorizeSecurityGroupIngressRequest.Builder
builder()
String
cidrIp()
The IPv4 address range, in CIDR format.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
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.List<IpPermission>
ipPermissions()
The permissions for the security group rules.String
ipProtocol()
List<SdkField<?>>
sdkFields()
static Class<? extends AuthorizeSecurityGroupIngressRequest.Builder>
serializableBuilderClass()
String
sourceSecurityGroupName()
[Default VPC] The name of the source security group.String
sourceSecurityGroupOwnerId()
The Amazon Web Services account ID for the source security group, if the source security group is in a different account.List<TagSpecification>
tagSpecifications()
The tags applied to the security group rule.AuthorizeSecurityGroupIngressRequest.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 IPv4 address range, in CIDR format.
To specify an IPv6 address range, use IP permissions instead.
To specify multiple rules and descriptions for the rules, use IP permissions instead.
- Returns:
- The IPv4 address range, in CIDR format.
To specify an IPv6 address range, use IP permissions instead.
To specify multiple rules and descriptions for the rules, use IP permissions instead.
-
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 ICMP type or -1 (all ICMP types).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
- Returns:
- If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the
ICMP type or -1 (all ICMP types).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
-
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. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
- Returns:
- [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID 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 permissions for 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
hasIpPermissions()
method.- Returns:
- The permissions for the security group rules.
-
ipProtocol
public final String ipProtocol()
The IP protocol name (
tcp
,udp
,icmp
) or number (see Protocol Numbers). To specify all protocols, use-1
.To specify
icmpv6
, use IP permissions instead.If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
To specify multiple rules and descriptions for the rules, use IP permissions instead.
- Returns:
- The IP protocol name (
tcp
,udp
,icmp
) or number (see Protocol Numbers). To specify all protocols, use-1
.To specify
icmpv6
, use IP permissions instead.If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
To specify multiple rules and descriptions for the rules, use IP permissions instead.
-
sourceSecurityGroupName
public final String sourceSecurityGroupName()
[Default VPC] The name of the source security group.
The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
- Returns:
- [Default VPC] The name of the source security group.
The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
-
sourceSecurityGroupOwnerId
public final String sourceSecurityGroupOwnerId()
The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
- Returns:
- The Amazon Web Services account ID for the source security group, if the source security group is in a
different account.
The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
-
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 ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
- Returns:
- If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the
ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1
(all ICMP codes).
To specify multiple rules and descriptions for the rules, use IP permissions instead.
-
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
.
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications 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.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags applied to the security group rule.
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
hasTagSpecifications()
method.- Returns:
- The tags applied to the security group rule.
-
toBuilder
public AuthorizeSecurityGroupIngressRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static AuthorizeSecurityGroupIngressRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends AuthorizeSecurityGroupIngressRequest.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
-
-