com.pulumi.awsnative.ec2.kotlin.CapacityReservation.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.ec2.kotlin
import com.pulumi.awsnative.ec2.kotlin.outputs.CapacityReservationTagSpecification
import com.pulumi.awsnative.ec2.kotlin.outputs.CapacityReservationTagSpecification.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [CapacityReservation].
*/
@PulumiTagMarker
public class CapacityReservationResourceBuilder internal constructor() {
public var name: String? = null
public var args: CapacityReservationArgs = CapacityReservationArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend CapacityReservationArgsBuilder.() -> Unit) {
val builder = CapacityReservationArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): CapacityReservation {
val builtJavaResource = com.pulumi.awsnative.ec2.CapacityReservation(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return CapacityReservation(builtJavaResource)
}
}
/**
* Resource Type definition for AWS::EC2::CapacityReservation
*/
public class CapacityReservation internal constructor(
override val javaResource: com.pulumi.awsnative.ec2.CapacityReservation,
) : KotlinCustomResource(javaResource, CapacityReservationMapper) {
/**
* The Availability Zone in which to create the Capacity Reservation.
*/
public val availabilityZone: Output
get() = javaResource.availabilityZone().applyValue({ args0 -> args0 })
/**
* Returns the remaining capacity, which indicates the number of instances that can be launched in the Capacity Reservation. For example: `9` .
*/
public val availableInstanceCount: Output
get() = javaResource.availableInstanceCount().applyValue({ args0 -> args0 })
/**
* The ID of the Capacity Reservation.
*/
public val awsId: Output
get() = javaResource.awsId().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val ebsOptimized: Output?
get() = javaResource.ebsOptimized().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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.
*/
public val endDate: Output?
get() = javaResource.endDate().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* 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` .
*/
public val endDateType: Output?
get() = javaResource.endDateType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* *Deprecated.*
*/
public val ephemeralStorage: Output?
get() = javaResource.ephemeralStorage().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The number of instances for which to reserve capacity.
* Valid range: 1 - 1000
*/
public val instanceCount: Output
get() = javaResource.instanceCount().applyValue({ args0 -> args0 })
/**
* 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.
* Default: `open`
*/
public val instanceMatchCriteria: Output?
get() = javaResource.instanceMatchCriteria().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The type of operating system for which to reserve capacity.
*/
public val instancePlatform: Output
get() = javaResource.instancePlatform().applyValue({ args0 -> args0 })
/**
* The instance type for which to reserve capacity. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide* .
*/
public val instanceType: Output
get() = javaResource.instanceType().applyValue({ args0 -> args0 })
/**
* The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
*/
public val outPostArn: Output?
get() = javaResource.outPostArn().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide* .
*/
public val placementGroupArn: Output?
get() = javaResource.placementGroupArn().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The tags to apply to the Capacity Reservation during launch.
*/
public val tagSpecifications: Output>?
get() = javaResource.tagSpecifications().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
}).orElse(null)
})
/**
* 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 AWS accounts .
* - `dedicated` - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account .
*/
public val tenancy: Output?
get() = javaResource.tenancy().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Returns the total number of instances for which the Capacity Reservation reserves capacity. For example: `15` .
*/
public val totalInstanceCount: Output
get() = javaResource.totalInstanceCount().applyValue({ args0 -> args0 })
}
public object CapacityReservationMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.ec2.CapacityReservation::class == javaResource::class
override fun map(javaResource: Resource): CapacityReservation = CapacityReservation(
javaResource
as com.pulumi.awsnative.ec2.CapacityReservation,
)
}
/**
* @see [CapacityReservation].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [CapacityReservation].
*/
public suspend fun capacityReservation(
name: String,
block: suspend CapacityReservationResourceBuilder.() -> Unit,
): CapacityReservation {
val builder = CapacityReservationResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [CapacityReservation].
* @param name The _unique_ name of the resulting resource.
*/
public fun capacityReservation(name: String): CapacityReservation {
val builder = CapacityReservationResourceBuilder()
builder.name(name)
return builder.build()
}