Interface AuthorizeSecurityGroupIngressRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>, Ec2Request.Builder, SdkBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
AuthorizeSecurityGroupIngressRequest
@Mutable @NotThreadSafe public static interface AuthorizeSecurityGroupIngressRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<AuthorizeSecurityGroupIngressRequest.Builder,AuthorizeSecurityGroupIngressRequest>

  • Method Details

    • cidrIp

      AuthorizeSecurityGroupIngressRequest.Builder cidrIp(String cidrIp)

      The IPv4 address range, in CIDR format.

      Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.

      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.

      Amazon Web Services canonicalizes IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, Amazon Web Services canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error.

      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

      AuthorizeSecurityGroupIngressRequest.Builder fromPort(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 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

      AuthorizeSecurityGroupIngressRequest.Builder groupId(String 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

      AuthorizeSecurityGroupIngressRequest.Builder groupName(String 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

      AuthorizeSecurityGroupIngressRequest.Builder ipPermissions(Collection<IpPermission> 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(IpPermission... 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 the IpPermission.Builder avoiding the need to create one manually via IpPermission.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ipPermissions(List<IpPermission>).

      Parameters:
      ipPermissions - a consumer that will call methods on IpPermission.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ipProtocol

      AuthorizeSecurityGroupIngressRequest.Builder ipProtocol(String 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

      AuthorizeSecurityGroupIngressRequest.Builder toPort(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 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.

    • 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 the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      AuthorizeSecurityGroupIngressRequest.Builder dryRun(Boolean 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 is UnauthorizedOperation.

      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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      AuthorizeSecurityGroupIngressRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.