@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
165 lines (164 loc) • 6.42 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Athena Capacity Reservation.
*
* > Destruction of this resource will both [cancel](https://docs.aws.amazon.com/athena/latest/ug/capacity-management-cancelling-a-capacity-reservation.html) and [delete](https://docs.aws.amazon.com/athena/latest/ug/capacity-management-deleting-a-capacity-reservation.html) the capacity reservation.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.athena.CapacityReservation("example", {
* name: "example-reservation",
* targetDpus: 24,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Athena Capacity Reservation using the `name`. For example:
*
* ```sh
* $ pulumi import aws:athena/capacityReservation:CapacityReservation example example-reservation
* ```
*/
export declare class CapacityReservation extends pulumi.CustomResource {
/**
* Get an existing CapacityReservation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CapacityReservationState, opts?: pulumi.CustomResourceOptions): CapacityReservation;
/**
* Returns true if the given object is an instance of CapacityReservation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is CapacityReservation;
/**
* Number of data processing units currently allocated.
*/
readonly allocatedDpus: pulumi.Output<number>;
/**
* ARN of the Capacity Reservation.
*/
readonly arn: pulumi.Output<string>;
/**
* Name of the capacity reservation.
*/
readonly name: pulumi.Output<string>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* Status of the capacity reservation.
*/
readonly status: pulumi.Output<string>;
/**
* Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Number of data processing units requested. Must be at least `24` units.
*
* The following arguments are optional:
*/
readonly targetDpus: pulumi.Output<number>;
readonly timeouts: pulumi.Output<outputs.athena.CapacityReservationTimeouts | undefined>;
/**
* Create a CapacityReservation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CapacityReservationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CapacityReservation resources.
*/
export interface CapacityReservationState {
/**
* Number of data processing units currently allocated.
*/
allocatedDpus?: pulumi.Input<number>;
/**
* ARN of the Capacity Reservation.
*/
arn?: pulumi.Input<string>;
/**
* Name of the capacity reservation.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Status of the capacity reservation.
*/
status?: pulumi.Input<string>;
/**
* Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Number of data processing units requested. Must be at least `24` units.
*
* The following arguments are optional:
*/
targetDpus?: pulumi.Input<number>;
timeouts?: pulumi.Input<inputs.athena.CapacityReservationTimeouts>;
}
/**
* The set of arguments for constructing a CapacityReservation resource.
*/
export interface CapacityReservationArgs {
/**
* Name of the capacity reservation.
*/
name?: pulumi.Input<string>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Number of data processing units requested. Must be at least `24` units.
*
* The following arguments are optional:
*/
targetDpus: pulumi.Input<number>;
timeouts?: pulumi.Input<inputs.athena.CapacityReservationTimeouts>;
}