Interface AuthorizeSecurityGroupIngressRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,
,AuthorizeSecurityGroupIngressRequest> Ec2Request.Builder
,SdkBuilder<AuthorizeSecurityGroupIngressRequest.Builder,
,AuthorizeSecurityGroupIngressRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
AuthorizeSecurityGroupIngressRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe IPv4 address range, in CIDR format.Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.If the protocol is TCP or UDP, this is the start of the port range.The ID of the security group.[Default VPC] The name of the security group.ipPermissions
(Collection<IpPermission> ipPermissions) The permissions for the security group rules.ipPermissions
(Consumer<IpPermission.Builder>... ipPermissions) The permissions for the security group rules.ipPermissions
(IpPermission... ipPermissions) The permissions for the security group rules.ipProtocol
(String ipProtocol) overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sourceSecurityGroupName
(String sourceSecurityGroupName) [Default VPC] The name of the source security group.sourceSecurityGroupOwnerId
(String sourceSecurityGroupOwnerId) The Amazon Web Services account ID for the source security group, if the source security group is in a different account.tagSpecifications
(Collection<TagSpecification> tagSpecifications) The tags applied to the security group rule.tagSpecifications
(Consumer<TagSpecification.Builder>... tagSpecifications) The tags applied to the security group rule.tagSpecifications
(TagSpecification... tagSpecifications) The tags applied to the security group rule.If the protocol is TCP or UDP, this is the end of the port range.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
groupId
The ID of the security group.
- Parameters:
groupId
- The ID of the security group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
ipPermissions
The permissions for the security group rules.
- Parameters:
ipPermissions
- The permissions for the security group rules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipPermissions
The permissions for the security group rules.
- Parameters:
ipPermissions
- The permissions for the security group rules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipPermissions
AuthorizeSecurityGroupIngressRequest.Builder ipPermissions(Consumer<IpPermission.Builder>... ipPermissions) The permissions for the security group rules.
This is a convenience method that creates an instance of theIpPermission.Builder
avoiding the need to create one manually viaIpPermission.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toipPermissions(List<IpPermission>)
.- Parameters:
ipPermissions
- a consumer that will call methods onIpPermission.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sourceSecurityGroupName
AuthorizeSecurityGroupIngressRequest.Builder sourceSecurityGroupName(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sourceSecurityGroupOwnerId
AuthorizeSecurityGroupIngressRequest.Builder sourceSecurityGroupOwnerId(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
AuthorizeSecurityGroupIngressRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags applied to the security group rule.
- Parameters:
tagSpecifications
- The tags applied to the security group rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
AuthorizeSecurityGroupIngressRequest.Builder tagSpecifications(TagSpecification... tagSpecifications) The tags applied to the security group rule.
- Parameters:
tagSpecifications
- The tags applied to the security group rule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagSpecifications
AuthorizeSecurityGroupIngressRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags applied to the security group rule.
This is a convenience method that creates an instance of theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totagSpecifications(List<TagSpecification>)
.- Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
AuthorizeSecurityGroupIngressRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
AuthorizeSecurityGroupIngressRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-