Package com.pulumi.aws.ec2

Class SpotInstanceRequestArgs

  • public final class SpotInstanceRequestArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • ami

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> ami()
        Returns:
        AMI to use for the instance. Required unless `launch_template` is specified and the Launch Template specifes an AMI. If an AMI is specified in the Launch Template, setting `ami` will override the AMI specified in the Launch Template.

      • associatePublicIpAddress

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> associatePublicIpAddress()
        Returns:
        Whether to associate a public IP address with an instance in a VPC.

      • availabilityZone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()
        Returns:
        AZ to start the instance in.

      • blockDurationMinutes

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> blockDurationMinutes()
        Returns:
        The required duration for the Spot instances, in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

      • capacityReservationSpecification

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestCapacityReservationSpecificationArgs>> capacityReservationSpecification()
        Returns:
        Describes an instance's Capacity Reservation targeting option. See Capacity Reservation Specification below for more details. > **NOTE:** Changing `cpu_core_count` and/or `cpu_threads_per_core` will cause the resource to be destroyed and re-created.

      • cpuCoreCount

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> cpuCoreCount()
        Deprecated.
        use 'cpu_options' argument instead
        Returns:
        Sets the number of CPU cores for an instance. This option is only supported on creation of instance type that support CPU Options [CPU Cores and Threads Per CPU Core Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html#cpu-options-supported-instances-values) - specifying this option for unsupported instance types will return an error from the EC2 API.

      • cpuOptions

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestCpuOptionsArgs>> cpuOptions()
        Returns:
        The CPU options for the instance. See CPU Options below for more details.

      • cpuThreadsPerCore

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> cpuThreadsPerCore()
        Deprecated.
        use 'cpu_options' argument instead
        Returns:
        If set to 1, hyperthreading is disabled on the launched instance. Defaults to 2 if not set. See [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) for more information.

      • creditSpecification

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestCreditSpecificationArgs>> creditSpecification()
        Returns:
        Configuration block for customizing the credit specification of the instance. See Credit Specification below for more details. This provider will only perform drift detection of its value when present in a configuration. Removing this configuration on existing instances will only stop managing it. It will not change the configuration back to the default for the instance type.

      • disableApiStop

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disableApiStop()
        Returns:
        If true, enables [EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection).

      • disableApiTermination

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> disableApiTermination()
        Returns:
        If true, enables [EC2 Instance Termination Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingDisableAPITermination).

      • ebsBlockDevices

        public java.util.Optional<com.pulumi.core.Output<java.util.List<SpotInstanceRequestEbsBlockDeviceArgs>>> ebsBlockDevices()
        Returns:
        One or more configuration blocks with additional EBS block devices to attach to the instance. Block device configurations only apply on resource creation. See Block Devices below for details on attributes and drift detection. When accessing this as an attribute reference, it is a set of objects.

      • ebsOptimized

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> ebsOptimized()
        Returns:
        If true, the launched EC2 instance will be EBS-optimized. Note that if this is not set on an instance type that is optimized by default then this will show as disabled but if the instance type is optimized by default then there is no need to set this and there is no effect to disabling it. See the [EBS Optimized section](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) of the AWS User Guide for more information.

      • enclaveOptions

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestEnclaveOptionsArgs>> enclaveOptions()
        Returns:
        Enable Nitro Enclaves on launched instances. See Enclave Options below for more details.

      • ephemeralBlockDevices

        public java.util.Optional<com.pulumi.core.Output<java.util.List<SpotInstanceRequestEphemeralBlockDeviceArgs>>> ephemeralBlockDevices()
        Returns:
        One or more configuration blocks to customize Ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below for details. When accessing this as an attribute reference, it is a set of objects.

      • getPasswordData

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> getPasswordData()
        Returns:
        If true, wait for password data to become available and retrieve it. Useful for getting the administrator password for instances running Microsoft Windows. The password data is exported to the `password_data` attribute. See [GetPasswordData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information.

      • hibernation

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> hibernation()
        Returns:
        If true, the launched EC2 instance will support hibernation.

      • hostId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostId()
        Returns:
        ID of a dedicated host that the instance will be assigned to. Use when an instance is to be launched on a specific dedicated host.

      • hostResourceGroupArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hostResourceGroupArn()
        Returns:
        ARN of the host resource group in which to launch the instances. If you specify an ARN, omit the `tenancy` parameter or set it to `host`.

      • iamInstanceProfile

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> iamInstanceProfile()
        Returns:
        IAM Instance Profile to launch the instance with. Specified as the name of the Instance Profile. Ensure your credentials have the correct permission to assign the instance profile according to the [EC2 documentation](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html#roles-usingrole-ec2instance-permissions), notably `iam:PassRole`.

      • instanceInitiatedShutdownBehavior

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> instanceInitiatedShutdownBehavior()
        Returns:
        Shutdown behavior for the instance. Amazon defaults this to `stop` for EBS-backed instances and `terminate` for instance-store instances. Cannot be set on instance-store instances. See [Shutdown Behavior](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingInstanceInitiatedShutdownBehavior) for more information.

      • instanceInterruptionBehavior

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> instanceInterruptionBehavior()
        Returns:
        Indicates Spot instance behavior when it is interrupted. Valid values are `terminate`, `stop`, or `hibernate`. Default value is `terminate`.

      • instanceType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> instanceType()
        Returns:
        Instance type to use for the instance. Required unless `launch_template` is specified and the Launch Template specifies an instance type. If an instance type is specified in the Launch Template, setting `instance_type` will override the instance type specified in the Launch Template. Updates to this field will trigger a stop/start of the EC2 instance.

      • ipv6AddressCount

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> ipv6AddressCount()
        Returns:
        Number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.

      • ipv6Addresses

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> ipv6Addresses()
        Returns:
        Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface

      • keyName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyName()
        Returns:
        Key name of the Key Pair to use for the instance; which can be managed using the `aws.ec2.KeyPair` resource.

      • launchGroup

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> launchGroup()
        Returns:
        A launch group is a group of spot instances that launch together and terminate together. If left empty instances are launched and terminated individually.

      • launchTemplate

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestLaunchTemplateArgs>> launchTemplate()
        Returns:
        Specifies a Launch Template to configure the instance. Parameters configured on this resource will override the corresponding parameters in the Launch Template. See Launch Template Specification below for more details.

      • maintenanceOptions

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestMaintenanceOptionsArgs>> maintenanceOptions()
        Returns:
        Maintenance and recovery options for the instance. See Maintenance Options below for more details.

      • metadataOptions

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestMetadataOptionsArgs>> metadataOptions()
        Returns:
        Customize the metadata options of the instance. See Metadata Options below for more details.

      • monitoring

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> monitoring()
        Returns:
        If true, the launched EC2 instance will have detailed monitoring enabled. (Available since v0.6.0)

      • networkInterfaces

        public java.util.Optional<com.pulumi.core.Output<java.util.List<SpotInstanceRequestNetworkInterfaceArgs>>> networkInterfaces()
        Returns:
        Customize network interfaces to be attached at instance boot time. See Network Interfaces below for more details.

      • placementGroup

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> placementGroup()
        Returns:
        Placement Group to start the instance in.

      • placementPartitionNumber

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> placementPartitionNumber()
        Returns:
        Number of the partition the instance is in. Valid only if the `aws.ec2.PlacementGroup` resource's `strategy` argument is set to `"partition"`.

      • privateDnsNameOptions

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestPrivateDnsNameOptionsArgs>> privateDnsNameOptions()
        Returns:
        Options for the instance hostname. The default values are inherited from the subnet. See Private DNS Name Options below for more details.

      • privateIp

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> privateIp()
        Returns:
        Private IP address to associate with the instance in a VPC.

      • rootBlockDevice

        public java.util.Optional<com.pulumi.core.Output<SpotInstanceRequestRootBlockDeviceArgs>> rootBlockDevice()
        Returns:
        Configuration block to customize details about the root block device of the instance. See Block Devices below for details. When accessing this as an attribute reference, it is a list containing one object.

      • secondaryPrivateIps

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> secondaryPrivateIps()
        Returns:
        List of secondary private IPv4 addresses to assign to the instance's primary network interface (eth0) in a VPC. Can only be assigned to the primary network interface (eth0) attached at instance creation, not a pre-existing network interface i.e., referenced in a `network_interface` block. Refer to the [Elastic network interfaces documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#AvailableIpPerENI) to see the maximum number of private IP addresses allowed per instance type.

      • securityGroups

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> securityGroups()
        Returns:
        List of security group names to associate with. > **NOTE:** If you are creating Instances in a VPC, use `vpc_security_group_ids` instead.

      • sourceDestCheck

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> sourceDestCheck()
        Returns:
        Controls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNs. Defaults true.

      • spotPrice

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> spotPrice()
        Returns:
        The maximum price to request on the spot market.

      • spotType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> spotType()
        Returns:
        If set to `one-time`, after the instance is terminated, the spot request will be closed.

      • subnetId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> subnetId()
        Returns:
        VPC Subnet ID to launch in.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. Note that these tags apply to the instance and not block storage devices. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tenancy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> tenancy()
        Returns:
        Tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of `dedicated` runs on single-tenant hardware. The `host` tenancy is not supported for the import-instance command. Valid values are `default`, `dedicated`, and `host`.

      • userData

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userData()
        Returns:
        User data to provide when launching the instance. Do not pass gzip-compressed data via this argument; see `user_data_base64` instead. Updates to this field will trigger a stop/start of the EC2 instance by default. If the `user_data_replace_on_change` is set then updates to this field will trigger a destroy and recreate.

      • userDataBase64

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userDataBase64()
        Returns:
        Can be used instead of `user_data` to pass base64-encoded binary data directly. Use this instead of `user_data` whenever the value is not a valid UTF-8 string. For example, gzip-encoded user data must be base64-encoded and passed via this argument to avoid corruption. Updates to this field will trigger a stop/start of the EC2 instance by default. If the `user_data_replace_on_change` is set then updates to this field will trigger a destroy and recreate.

      • userDataReplaceOnChange

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> userDataReplaceOnChange()
        Returns:
        When used in combination with `user_data` or `user_data_base64` will trigger a destroy and recreate when set to `true`. Defaults to `false` if not set.

      • validFrom

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> validFrom()
        Returns:
        The start date and time of the request, in UTC [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.8) format(for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

      • validUntil

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> validUntil()
        Returns:
        The end date and time of the request, in UTC [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.8) format(for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request. The default end date is 7 days from the current date.

      • volumeTags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> volumeTags()
        Returns:
        Map of tags to assign, at instance-creation time, to root and EBS volumes. > **NOTE:** Do not use `volume_tags` if you plan to manage block device tags outside the `aws.ec2.Instance` configuration, such as using `tags` in an `aws.ebs.Volume` resource attached via `aws.ec2.VolumeAttachment`. Doing so will result in resource cycling and inconsistent behavior.

      • vpcSecurityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()
        Returns:
        List of security group IDs to associate with.

      • waitForFulfillment

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> waitForFulfillment()
        Returns:
        If set, this provider will wait for the Spot Request to be fulfilled, and will throw an error if the timeout of 10m is reached.