Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. athena
  5. getCapacityReservation

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.athena.getCapacityReservation

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::Athena::CapacityReservation

    Using getCapacityReservation

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCapacityReservation(args: GetCapacityReservationArgs, opts?: InvokeOptions): Promise<GetCapacityReservationResult>
function getCapacityReservationOutput(args: GetCapacityReservationOutputArgs, opts?: InvokeOptions): Output<GetCapacityReservationResult>
    def get_capacity_reservation(arn: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCapacityReservationResult
def get_capacity_reservation_output(arn: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetCapacityReservationResult]
    func LookupCapacityReservation(ctx *Context, args *LookupCapacityReservationArgs, opts ...InvokeOption) (*LookupCapacityReservationResult, error)
func LookupCapacityReservationOutput(ctx *Context, args *LookupCapacityReservationOutputArgs, opts ...InvokeOption) LookupCapacityReservationResultOutput

    > Note: This function is named LookupCapacityReservation in the Go SDK.

    public static class GetCapacityReservation 
{
    public static Task<GetCapacityReservationResult> InvokeAsync(GetCapacityReservationArgs args, InvokeOptions? opts = null)
    public static Output<GetCapacityReservationResult> Invoke(GetCapacityReservationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCapacityReservationResult> getCapacityReservation(GetCapacityReservationArgs args, InvokeOptions options)
public static Output<GetCapacityReservationResult> getCapacityReservation(GetCapacityReservationArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:athena:getCapacityReservation
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The ARN of the capacity reservation.
    Arn string
    The ARN of the capacity reservation.
    arn String
    The ARN of the capacity reservation.
    arn string
    The ARN of the capacity reservation.
    arn str
    The ARN of the capacity reservation.
    arn String
    The ARN of the capacity reservation.

    getCapacityReservation Result

    The following output properties are available:

    AllocatedDpus int
    The number of DPUs Athena has provisioned and allocated for the reservation
    Arn string
    The ARN of the capacity reservation.
    CapacityAssignmentConfiguration Pulumi.AwsNative.Athena.Outputs.CapacityReservationCapacityAssignmentConfiguration
    Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
    CreationTime string
    The date and time the reservation was created.
    LastSuccessfulAllocationTime string
    The timestamp when the last successful allocated was made
    Status Pulumi.AwsNative.Athena.CapacityReservationStatus
    The status of the reservation.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    TargetDpus int
    The number of DPUs to request to be allocated to the reservation.
    AllocatedDpus int
    The number of DPUs Athena has provisioned and allocated for the reservation
    Arn string
    The ARN of the capacity reservation.
    CapacityAssignmentConfiguration CapacityReservationCapacityAssignmentConfiguration
    Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
    CreationTime string
    The date and time the reservation was created.
    LastSuccessfulAllocationTime string
    The timestamp when the last successful allocated was made
    Status CapacityReservationStatus
    The status of the reservation.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    TargetDpus int
    The number of DPUs to request to be allocated to the reservation.
    allocatedDpus Integer
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn String
    The ARN of the capacity reservation.
    capacityAssignmentConfiguration CapacityReservationCapacityAssignmentConfiguration
    Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
    creationTime String
    The date and time the reservation was created.
    lastSuccessfulAllocationTime String
    The timestamp when the last successful allocated was made
    status CapacityReservationStatus
    The status of the reservation.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    targetDpus Integer
    The number of DPUs to request to be allocated to the reservation.
    allocatedDpus number
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn string
    The ARN of the capacity reservation.
    capacityAssignmentConfiguration CapacityReservationCapacityAssignmentConfiguration
    Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
    creationTime string
    The date and time the reservation was created.
    lastSuccessfulAllocationTime string
    The timestamp when the last successful allocated was made
    status CapacityReservationStatus
    The status of the reservation.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    targetDpus number
    The number of DPUs to request to be allocated to the reservation.
    allocated_dpus int
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn str
    The ARN of the capacity reservation.
    capacity_assignment_configuration CapacityReservationCapacityAssignmentConfiguration
    Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
    creation_time str
    The date and time the reservation was created.
    last_successful_allocation_time str
    The timestamp when the last successful allocated was made
    status CapacityReservationStatus
    The status of the reservation.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    target_dpus int
    The number of DPUs to request to be allocated to the reservation.
    allocatedDpus Number
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn String
    The ARN of the capacity reservation.
    capacityAssignmentConfiguration Property Map
    Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.
    creationTime String
    The date and time the reservation was created.
    lastSuccessfulAllocationTime String
    The timestamp when the last successful allocated was made
    status "PENDING" | "ACTIVE" | "CANCELLING" | "CANCELLED" | "FAILED" | "UPDATE_PENDING"
    The status of the reservation.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    targetDpus Number
    The number of DPUs to request to be allocated to the reservation.

    Supporting Types

    CapacityReservationCapacityAssignment

    WorkgroupNames List<string>
    workgroupNames List<String>
    workgroup_names Sequence[str]
    workgroupNames List<String>

    CapacityReservationCapacityAssignmentConfiguration

    CapacityAssignments List<Pulumi.AwsNative.Athena.Inputs.CapacityReservationCapacityAssignment>
    The list of assignments that make up the capacity assignment configuration.
    CapacityAssignments []CapacityReservationCapacityAssignment
    The list of assignments that make up the capacity assignment configuration.
    capacityAssignments List<CapacityReservationCapacityAssignment>
    The list of assignments that make up the capacity assignment configuration.
    capacityAssignments CapacityReservationCapacityAssignment[]
    The list of assignments that make up the capacity assignment configuration.
    capacity_assignments Sequence[CapacityReservationCapacityAssignment]
    The list of assignments that make up the capacity assignment configuration.
    capacityAssignments List<Property Map>
    The list of assignments that make up the capacity assignment configuration.

    CapacityReservationStatus

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native