software.amazon.awssdk.services.ec2.model

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(value="software.amazon.awssdk:codegen")
public final class AuthorizeSecurityGroupIngressRequest
extends Ec2Request
implements ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthorizeSecurityGroupIngressRequest.Builder

Method Summary

Modifier and Type	Method and Description
static AuthorizeSecurityGroupIngressRequest.Builder	builder()
String	cidrIp() The IPv4 address range, in CIDR format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fromPort() The start of port range for the TCP and UDP protocols, or an ICMP type number.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId() The ID of the security group.
String	groupName() [EC2-Classic, default VPC] The name of the security group.
int	hashCode()
boolean	hasIpPermissions() Returns true if the IpPermissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<IpPermission>	ipPermissions() The sets of IP permissions.
String	ipProtocol() The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
List<SdkField<?>>	sdkFields()
static Class<? extends AuthorizeSecurityGroupIngressRequest.Builder>	serializableBuilderClass()
String	sourceSecurityGroupName() [EC2-Classic, default VPC] The name of the source security group.
String	sourceSecurityGroupOwnerId() [nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account.
AuthorizeSecurityGroupIngressRequest.Builder	toBuilder()
Integer	toPort() The end of port range for the TCP and UDP protocols, or an ICMP code number.
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 String cidrIp()

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

fromPort

public Integer fromPort()

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

groupId

public String groupId()

The ID 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:

The ID 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.

groupName

public String groupName()

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

Returns:

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

hasIpPermissions

public boolean hasIpPermissions()

Returns true if the IpPermissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ipPermissions

public List<IpPermission> ipPermissions()

The sets of IP permissions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIpPermissions() to see if a value was sent in this field.

Returns:

The sets of IP permissions.

ipProtocol

public String ipProtocol()

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

sourceSecurityGroupName

public String sourceSecurityGroupName()

[EC2-Classic, 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. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

Returns:

[EC2-Classic, 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. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

sourceSecurityGroupOwnerId

public String sourceSecurityGroupOwnerId()

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

Returns:

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

toPort

public Integer toPort()

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

Returns:

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

toBuilder

public AuthorizeSecurityGroupIngressRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static AuthorizeSecurityGroupIngressRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AuthorizeSecurityGroupIngressRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo