Package software.amazon.awssdk.services.ec2.model

Class ModifyIpamRequest

    • Method Detail

      • dryRun

        public final Boolean dryRun()

        A check for 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:
        A check for 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.

      • ipamId

        public final String ipamId()

        The ID of the IPAM you want to modify.

        Returns:
        The ID of the IPAM you want to modify.

      • description

        public final String description()

        The description of the IPAM you want to modify.

        Returns:
        The description of the IPAM you want to modify.

      • hasAddOperatingRegions

        public final boolean hasAddOperatingRegions()
        For responses, this returns true if the service returned a value for the AddOperatingRegions 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.

      • addOperatingRegions

        public final List<AddIpamOperatingRegion> addOperatingRegions()

        Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

        For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

        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 hasAddOperatingRegions() method.

        Returns:
        Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

        For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

      • hasRemoveOperatingRegions

        public final boolean hasRemoveOperatingRegions()
        For responses, this returns true if the service returned a value for the RemoveOperatingRegions 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.

      • removeOperatingRegions

        public final List<RemoveIpamOperatingRegion> removeOperatingRegions()

        The operating Regions to remove.

        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 hasRemoveOperatingRegions() method.

        Returns:
        The operating Regions to remove.

      • tier

        public final IpamTier tier()

        IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

        If the service returns an enum value that is not available in the current SDK version, tier will return IpamTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().

        Returns:
        IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
        See Also:
        IpamTier

      • tierAsString

        public final String tierAsString()

        IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

        If the service returns an enum value that is not available in the current SDK version, tier will return IpamTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tierAsString().

        Returns:
        IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
        See Also:
        IpamTier

      • 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