Class AuthorizeSecurityGroupIngressRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,
AuthorizeSecurityGroupIngressRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
cidrIp()
The IPv4 address range, in CIDR format.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
fromPort()
If the protocol is TCP or UDP, this is the start of the port range.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
groupId()
The ID of the security group.final String
[Default VPC] The name of the security group.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IpPermissions property.final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.final List
<IpPermission> The permissions for the security group rules.final String
static Class
<? extends AuthorizeSecurityGroupIngressRequest.Builder> final String
[Default VPC] The name of the source security group.final String
The Amazon Web Services account ID for the source security group, if the source security group is in a different account.final List
<TagSpecification> The tags applied to the security group rule.Take this object and create a builder that contains all of the current property values of this object.final Integer
toPort()
If the protocol is TCP or UDP, this is the end of the port range.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The ID of the security group.
- Returns:
- The ID of the security group.
-
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
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
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
[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
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
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
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
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
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 interfaceToCopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,
AuthorizeSecurityGroupIngressRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AuthorizeSecurityGroupIngressRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-