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

Class DescribeReservedInstancesOfferingsRequest

    • Method Detail

      • availabilityZone

        public final String availabilityZone()

        The Availability Zone in which the Reserved Instance can be used.

        Returns:
        The Availability Zone in which the Reserved Instance can be used.

      • hasFilters

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

      • filters

        public final List<Filter> filters()

        One or more filters.

        • availability-zone - The Availability Zone where the Reserved Instance can be used.

        • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

        • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

        • instance-type - The instance type that is covered by the reservation.

        • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

        • product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).

        • reserved-instances-offering-id - The Reserved Instances offering ID.

        • scope - The scope of the Reserved Instance (Availability Zone or Region).

        • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

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

        Returns:
        One or more filters.

        • availability-zone - The Availability Zone where the Reserved Instance can be used.

        • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

        • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

        • instance-type - The instance type that is covered by the reservation.

        • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.

        • product-description - The Reserved Instance product platform description ( Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).

        • reserved-instances-offering-id - The Reserved Instances offering ID.

        • scope - The scope of the Reserved Instance (Availability Zone or Region).

        • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

      • includeMarketplace

        public final Boolean includeMarketplace()

        Include Reserved Instance Marketplace offerings in the response.

        Returns:
        Include Reserved Instance Marketplace offerings in the response.

      • instanceType

        public final InstanceType instanceType()

        The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.

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

        Returns:
        The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.
        See Also:
        InstanceType

      • instanceTypeAsString

        public final String instanceTypeAsString()

        The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.

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

        Returns:
        The instance type that the reservation will cover (for example, m1.small). For more information, see Instance types in the Amazon EC2 User Guide.
        See Also:
        InstanceType

      • maxDuration

        public final Long maxDuration()

        The maximum duration (in seconds) to filter when searching for offerings.

        Default: 94608000 (3 years)

        Returns:
        The maximum duration (in seconds) to filter when searching for offerings.

        Default: 94608000 (3 years)

      • maxInstanceCount

        public final Integer maxInstanceCount()

        The maximum number of instances to filter when searching for offerings.

        Default: 20

        Returns:
        The maximum number of instances to filter when searching for offerings.

        Default: 20

      • minDuration

        public final Long minDuration()

        The minimum duration (in seconds) to filter when searching for offerings.

        Default: 2592000 (1 month)

        Returns:
        The minimum duration (in seconds) to filter when searching for offerings.

        Default: 2592000 (1 month)

      • offeringClassAsString

        public final String offeringClassAsString()

        The offering class of the Reserved Instance. Can be standard or convertible.

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

        Returns:
        The offering class of the Reserved Instance. Can be standard or convertible.
        See Also:
        OfferingClassType

      • productDescriptionAsString

        public final String productDescriptionAsString()

        The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

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

        Returns:
        The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
        See Also:
        RIProductDescription

      • hasReservedInstancesOfferingIds

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

      • reservedInstancesOfferingIds

        public final List<String> reservedInstancesOfferingIds()

        One or more Reserved Instances offering IDs.

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

        Returns:
        One or more Reserved Instances offering IDs.

      • dryRun

        public final 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.

        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 is UnauthorizedOperation.

      • instanceTenancy

        public final Tenancy instanceTenancy()

        The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

        Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

        Default: default

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

        Returns:
        The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

        Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

        Default: default

        See Also:
        Tenancy

      • instanceTenancyAsString

        public final String instanceTenancyAsString()

        The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

        Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

        Default: default

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

        Returns:
        The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

        Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

        Default: default

        See Also:
        Tenancy

      • maxResults

        public final Integer maxResults()

        The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

        Default: 100

        Returns:
        The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

        Default: 100

      • nextToken

        public final String nextToken()

        The token to retrieve the next page of results.

        Returns:
        The token to retrieve the next page of results.

      • offeringType

        public final OfferingTypeValues offeringType()

        The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

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

        Returns:
        The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
        See Also:
        OfferingTypeValues

      • offeringTypeAsString

        public final String offeringTypeAsString()

        The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

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

        Returns:
        The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
        See Also:
        OfferingTypeValues

      • 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