Package com.pulumi.aws.ec2

Class CapacityBlockReservation

  • public class CapacityBlockReservation
extends com.pulumi.resources.CustomResource
    Provides an EC2 Capacity Block Reservation. This allows you to purchase capacity block for your Amazon EC2 instances in a specific Availability Zone for machine learning (ML) Workloads. > **NOTE:** Once created, a reservation is valid for the `duration` of the provided `capacityBlockOfferingId` and cannot be deleted. Performing a `destroy` will only remove the resource from state. For more information see [EC2 Capacity Block Reservation Documentation](https://aws.amazon.com/ec2/instance-types/p5/) and [PurchaseReservedDBInstancesOffering](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-blocks-pricing-billing.html). > **NOTE:** Due to the expense of testing this resource, we provide it as best effort. If you find it useful, and have the ability to help test or notice issues, consider reaching out to us on GitHub. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.Ec2Functions;
 import com.pulumi.aws.ec2.inputs.GetCapacityBlockOfferingArgs;
 import com.pulumi.aws.ec2.CapacityBlockReservation;
 import com.pulumi.aws.ec2.CapacityBlockReservationArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         final var test = Ec2Functions.getCapacityBlockOffering(GetCapacityBlockOfferingArgs.builder()
             .capacityDurationHours(24)
             .endDateRange("2024-05-30T15:04:05Z")
             .instanceCount(1)
             .instanceType("p5.4xlarge")
             .startDateRange("2024-04-28T15:04:05Z")
             .build());
 
         var example = new CapacityBlockReservation("example", CapacityBlockReservationArgs.builder()
             .capacityBlockOfferingId(test.capacityBlockOfferingId())
             .instancePlatform("Linux/UNIX")
             .build());
 
     }
 }

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> availabilityZone()  
      com.pulumi.core.Output<java.lang.String> capacityBlockOfferingId()  
      com.pulumi.core.Output<java.lang.String> createdDate()  
      com.pulumi.core.Output<java.lang.Boolean> ebsOptimized()  
      com.pulumi.core.Output<java.lang.String> endDate()  
      com.pulumi.core.Output<java.lang.String> endDateType()  
      static CapacityBlockReservation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CapacityBlockReservationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.Integer> instanceCount()  
      com.pulumi.core.Output<java.lang.String> instancePlatform()  
      com.pulumi.core.Output<java.lang.String> instanceType()  
      com.pulumi.core.Output<java.lang.String> outpostArn()  
      com.pulumi.core.Output<java.lang.String> placementGroupArn()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> reservationType()  
      com.pulumi.core.Output<java.lang.String> startDate()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> tenancy()  
      com.pulumi.core.Output<java.util.Optional<CapacityBlockReservationTimeouts>> timeouts()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CapacityBlockReservation

        public CapacityBlockReservation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • CapacityBlockReservation

        public CapacityBlockReservation​(java.lang.String name,
                                CapacityBlockReservationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • CapacityBlockReservation

        public CapacityBlockReservation​(java.lang.String name,
                                CapacityBlockReservationArgs args,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the reservation.

      • availabilityZone

        public com.pulumi.core.Output<java.lang.String> availabilityZone()
        Returns:
        The Availability Zone in which to create the Capacity Block Reservation.

      • capacityBlockOfferingId

        public com.pulumi.core.Output<java.lang.String> capacityBlockOfferingId()
        Returns:
        The Capacity Block Reservation ID.

      • createdDate

        public com.pulumi.core.Output<java.lang.String> createdDate()
        Returns:
        The date and time at which the Capacity Block Reservation was created.

      • ebsOptimized

        public com.pulumi.core.Output<java.lang.Boolean> ebsOptimized()
        Returns:
        Indicates whether the Capacity Reservation supports EBS-optimized instances.

      • endDate

        public com.pulumi.core.Output<java.lang.String> endDate()
        Returns:
        The date and time at which the Capacity Block Reservation expires. When a Capacity Block Reservation expires, the reserved capacity is released and you can no longer launch instances into it. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`)

      • endDateType

        public com.pulumi.core.Output<java.lang.String> endDateType()
        Returns:
        Indicates the way in which the Capacity Reservation ends.

      • instanceCount

        public com.pulumi.core.Output<java.lang.Integer> instanceCount()
        Returns:
        The number of instances for which to reserve capacity. This value will not be set until the Capacity Block Reservation is active. The requested instance count is set in the tag `aws:ec2capacityreservation:incrementalRequestedQuantity`.

      • instancePlatform

        public com.pulumi.core.Output<java.lang.String> instancePlatform()
        Returns:
        The type of operating system for which to reserve capacity. Valid options are `Linux/UNIX`, `Red Hat Enterprise Linux`, `SUSE Linux`, `Windows`, `Windows with SQL Server`, `Windows with SQL Server Enterprise`, `Windows with SQL Server Standard` or `Windows with SQL Server Web`.

      • instanceType

        public com.pulumi.core.Output<java.lang.String> instanceType()
        Returns:
        The instance type for which to reserve capacity.

      • outpostArn

        public com.pulumi.core.Output<java.lang.String> outpostArn()
        Returns:
        The ARN of the Outpost on which to create the Capacity Block Reservation.

      • placementGroupArn

        public com.pulumi.core.Output<java.lang.String> placementGroupArn()
        Returns:
        The ARN of the placement group in which to create the Capacity Block Reservation.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • reservationType

        public com.pulumi.core.Output<java.lang.String> reservationType()
        Returns:
        The type of Capacity Reservation.

      • startDate

        public com.pulumi.core.Output<java.lang.String> startDate()
        Returns:
        The date and time at which the Capacity Block Reservation starts. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`)

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block

      • tenancy

        public com.pulumi.core.Output<java.lang.String> tenancy()
        Returns:
        Indicates the tenancy of the Capacity Block Reservation. Specify either `default` or `dedicated`.

      • get

        public static CapacityBlockReservation get​(java.lang.String name,
                                           com.pulumi.core.Output<java.lang.String> id,
                                           @Nullable
                                           CapacityBlockReservationState state,
                                           @Nullable
                                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.