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 sets of IP permissions.ipPermissions
(Consumer<IpPermission.Builder>... ipPermissions) The sets of IP permissions.ipPermissions
(IpPermission... ipPermissions) The sets of IP permissions.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) [Nondefault VPC] 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) [VPC Only] The tags applied to the security group rule.tagSpecifications
(Consumer<TagSpecification.Builder>... tagSpecifications) [VPC Only] The tags applied to the security group rule.tagSpecifications
(TagSpecification... tagSpecifications) [VPC Only] 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. 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.
- Parameters:
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:
- 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 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.
- 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 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
groupName
[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.
- Parameters:
groupName
- [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:
- Returns a reference to this object so that method calls can be chained together.
-
ipPermissions
The sets of IP permissions.
- Parameters:
ipPermissions
- The sets of IP permissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipPermissions
The sets of IP permissions.
- Parameters:
ipPermissions
- The sets of IP permissions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ipPermissions
AuthorizeSecurityGroupIngressRequest.Builder ipPermissions(Consumer<IpPermission.Builder>... ipPermissions) The sets of IP permissions.
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 specifyicmpv6
, use a set of IP permissions.Use
-1
to specify all protocols. If you specify-1
or a protocol other thantcp
,udp
, oricmp
, 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.
- Parameters:
ipProtocol
- The IP protocol name (tcp
,udp
,icmp
) or number (see Protocol Numbers). To specifyicmpv6
, use a set of IP permissions.Use
-1
to specify all protocols. If you specify-1
or a protocol other thantcp
,udp
, oricmp
, 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:
- 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. 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. The source security group must be in the same VPC.
- Parameters:
sourceSecurityGroupName
- [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. The source security group must be in the same VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceSecurityGroupOwnerId
AuthorizeSecurityGroupIngressRequest.Builder sourceSecurityGroupOwnerId(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.
- Parameters:
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:
- 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 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.
- 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 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:
- 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) [VPC Only] The tags applied to the security group rule.
- Parameters:
tagSpecifications
- [VPC Only] 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) [VPC Only] The tags applied to the security group rule.
- Parameters:
tagSpecifications
- [VPC Only] 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) [VPC Only] 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.
-