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

Class AuthorizeSecurityGroupIngressRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.AuthorizeSecurityGroupIngressRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>

@Generated("software.amazon.awssdk:codegen")
public class AuthorizeSecurityGroupIngressRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>

Contains the parameters for AuthorizeSecurityGroupIngress.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AuthorizeSecurityGroupIngressRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static AuthorizeSecurityGroupIngressRequest.Builder	builder()
String	cidrIp()	The CIDR IPv4 address range.
boolean	equals(Object obj)
Integer	fromPort()	The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
String	groupId()	The ID of the security group.
String	groupName()	[EC2-Classic, default VPC] The name of the security group.
int	hashCode()
List<IpPermission>	ipPermissions()	A set of IP permissions.
String	ipProtocol()	The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
static Class<? extends AuthorizeSecurityGroupIngressRequest.Builder>	serializableBuilderClass()
String	sourceSecurityGroupName()	[EC2-Classic, default VPC] The name of the source security group.
String	sourceSecurityGroupOwnerId()	[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account.
AuthorizeSecurityGroupIngressRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Integer	toPort()	The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cidrIp

public String cidrIp()

The CIDR IPv4 address range. You can't specify this parameter when specifying a source security group.

Returns:

The CIDR IPv4 address range. You can't specify this parameter when specifying a source security group.

fromPort

public Integer fromPort()

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

Returns:

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

groupId

public String groupId()

The ID of the security group. Required for a nondefault VPC.

Returns:

The ID of the security group. Required for a nondefault VPC.

groupName

public String groupName()

[EC2-Classic, default VPC] The name of the security group.

Returns:

[EC2-Classic, default VPC] The name of the security group.

ipPermissions

public List<IpPermission> ipPermissions()

A set of IP permissions. Can be used to specify multiple rules in a single command.

Returns:

A set of IP permissions. Can be used to specify multiple rules in a single command.

ipProtocol

public String ipProtocol()

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed.

Returns:

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed.

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()

[EC2-Classic] The AWS account number 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:

[EC2-Classic] The AWS account number 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/ICMPv6 code number. For the ICMP/ICMPv6 code number, use -1 to specify all codes.

Returns:

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

toBuilder

public AuthorizeSecurityGroupIngressRequest.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<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>

Returns:

a builder for type T

builder

public static AuthorizeSecurityGroupIngressRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object