AuthorizeSecurityGroupIngressRequest (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AuthorizeSecurityGroupIngressRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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()` [EC2-Classic, 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 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 Amazon Web Services account ID for the source security group, if the source security group is in a different account.
`List<TagSpecification>`	`tagSpecifications()` [VPC Only] 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. 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 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. If you specify all ICMP types, you must specify all ICMP codes.
    
    Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
    
    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. If you specify all ICMP types, you must specify all ICMP codes.
    
    Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
  - groupId
```
public final 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 final 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. For security groups in a nondefault VPC, you must specify the security group ID.
    
    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. 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 the isEmpty() 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.
    
    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.
  - ipProtocol
```
public final 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 final 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 final String sourceSecurityGroupOwnerId()
```
    [nondefault VPC] The Amazon Web Services 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 Amazon Web Services 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 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. If you specify all ICMP types, you must specify all ICMP codes.
    
    Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
    
    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. If you specify all ICMP types, you must specify all ICMP codes.
    
    Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
  - 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 the isEmpty() 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()
```
    [VPC Only] 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:
    
    [VPC Only] The tags applied to the security group 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AuthorizeSecurityGroupIngressRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

cidrIp

fromPort

groupId

groupName

hasIpPermissions

ipPermissions

ipProtocol

sourceSecurityGroupName

sourceSecurityGroupOwnerId

toPort

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields