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

Interface CreateCapacityReservationRequest.Builder

    • Method Detail

      • clientToken

        CreateCapacityReservationRequest.Builder clientToken​(String clientToken)

        Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

        Parameters:
        clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceType

        CreateCapacityReservationRequest.Builder instanceType​(String instanceType)

        The instance type for which to reserve capacity.

        You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

        For more information, see Instance types in the Amazon EC2 User Guide.

        Parameters:
        instanceType - The instance type for which to reserve capacity.

        You can request future-dated Capacity Reservations for instance types in the C, M, R, I, and T instance families only.

        For more information, see Instance types in the Amazon EC2 User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZone

        CreateCapacityReservationRequest.Builder availabilityZone​(String availabilityZone)

        The Availability Zone in which to create the Capacity Reservation.

        Parameters:
        availabilityZone - The Availability Zone in which to create the Capacity Reservation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZoneId

        CreateCapacityReservationRequest.Builder availabilityZoneId​(String availabilityZoneId)

        The ID of the Availability Zone in which to create the Capacity Reservation.

        Parameters:
        availabilityZoneId - The ID of the Availability Zone in which to create the Capacity Reservation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tenancy

        CreateCapacityReservationRequest.Builder tenancy​(String tenancy)

        Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

        • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

        • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

        Parameters:
        tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

        • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

        • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CapacityReservationTenancy, CapacityReservationTenancy

      • tenancy

        CreateCapacityReservationRequest.Builder tenancy​(CapacityReservationTenancy tenancy)

        Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

        • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

        • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

        Parameters:
        tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

        • default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.

        • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CapacityReservationTenancy, CapacityReservationTenancy

      • instanceCount

        CreateCapacityReservationRequest.Builder instanceCount​(Integer instanceCount)

        The number of instances for which to reserve capacity.

        You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances (25 * m5.xlarge = 100 vCPUs).

        Valid range: 1 - 1000

        Parameters:
        instanceCount - The number of instances for which to reserve capacity.

        You can request future-dated Capacity Reservations for an instance count with a minimum of 100 VPUs. For example, if you request a future-dated Capacity Reservation for m5.xlarge instances, you must request at least 25 instances (25 * m5.xlarge = 100 vCPUs).

        Valid range: 1 - 1000

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ebsOptimized

        CreateCapacityReservationRequest.Builder ebsOptimized​(Boolean ebsOptimized)

        Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

        Parameters:
        ebsOptimized - Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ephemeralStorage

        CreateCapacityReservationRequest.Builder ephemeralStorage​(Boolean ephemeralStorage)

        Deprecated.

        Parameters:
        ephemeralStorage - Deprecated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endDate

        CreateCapacityReservationRequest.Builder endDate​(Instant endDate)

        The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

        You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

        If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

        If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

        Parameters:
        endDate - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

        You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

        If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

        If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endDateType

        CreateCapacityReservationRequest.Builder endDateType​(String endDateType)

        Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

        • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

        • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

        Parameters:
        endDateType - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

        • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

        • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EndDateType, EndDateType

      • endDateType

        CreateCapacityReservationRequest.Builder endDateType​(EndDateType endDateType)

        Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

        • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

        • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

        Parameters:
        endDateType - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

        • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

        • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        EndDateType, EndDateType

      • instanceMatchCriteria

        CreateCapacityReservationRequest.Builder instanceMatchCriteria​(String instanceMatchCriteria)

        Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

        • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

        • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

        If you are requesting a future-dated Capacity Reservation, you must specify targeted.

        Default: open

        Parameters:
        instanceMatchCriteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

        • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

        • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

        If you are requesting a future-dated Capacity Reservation, you must specify targeted.

        Default: open

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceMatchCriteria, InstanceMatchCriteria

      • instanceMatchCriteria

        CreateCapacityReservationRequest.Builder instanceMatchCriteria​(InstanceMatchCriteria instanceMatchCriteria)

        Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

        • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

        • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

        If you are requesting a future-dated Capacity Reservation, you must specify targeted.

        Default: open

        Parameters:
        instanceMatchCriteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

        • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

        • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

        If you are requesting a future-dated Capacity Reservation, you must specify targeted.

        Default: open

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceMatchCriteria, InstanceMatchCriteria

      • tagSpecifications

        CreateCapacityReservationRequest.Builder tagSpecifications​(Collection<TagSpecification> tagSpecifications)

        The tags to apply to the Capacity Reservation during launch.

        Parameters:
        tagSpecifications - The tags to apply to the Capacity Reservation during launch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagSpecifications

        CreateCapacityReservationRequest.Builder tagSpecifications​(TagSpecification... tagSpecifications)

        The tags to apply to the Capacity Reservation during launch.

        Parameters:
        tagSpecifications - The tags to apply to the Capacity Reservation during launch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dryRun

        CreateCapacityReservationRequest.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.

      • outpostArn

        CreateCapacityReservationRequest.Builder outpostArn​(String outpostArn)

        Not supported for future-dated Capacity Reservations.

        The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

        Parameters:
        outpostArn -

        Not supported for future-dated Capacity Reservations.

        The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • placementGroupArn

        CreateCapacityReservationRequest.Builder placementGroupArn​(String placementGroupArn)

        Not supported for future-dated Capacity Reservations.

        The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

        Parameters:
        placementGroupArn -

        Not supported for future-dated Capacity Reservations.

        The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startDate

        CreateCapacityReservationRequest.Builder startDate​(Instant startDate)

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

        You can request a future-dated Capacity Reservation between 5 and 120 days in advance.

        Parameters:
        startDate -

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ).

        You can request a future-dated Capacity Reservation between 5 and 120 days in advance.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • commitmentDuration

        CreateCapacityReservationRequest.Builder commitmentDuration​(Long commitmentDuration)

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

        The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the active state in your account after it has been delivered.

        For more information, see Commitment duration.

        Parameters:
        commitmentDuration -

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

        The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the active state in your account after it has been delivered.

        For more information, see Commitment duration.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deliveryPreference

        CreateCapacityReservationRequest.Builder deliveryPreference​(String deliveryPreference)

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

        The only supported value is incremental.

        Parameters:
        deliveryPreference -

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

        The only supported value is incremental.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CapacityReservationDeliveryPreference, CapacityReservationDeliveryPreference

      • deliveryPreference

        CreateCapacityReservationRequest.Builder deliveryPreference​(CapacityReservationDeliveryPreference deliveryPreference)

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

        The only supported value is incremental.

        Parameters:
        deliveryPreference -

        Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter.

        Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

        The only supported value is incremental.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        CapacityReservationDeliveryPreference, CapacityReservationDeliveryPreference