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

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.CapacityReservation

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

    Create CapacityReservation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CapacityReservation(name: string, args: CapacityReservationArgs, opts?: CustomResourceOptions);
    @overload
def CapacityReservation(resource_name: str,
                        args: CapacityReservationArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def CapacityReservation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        target_dpus: Optional[int] = None,
                        capacity_assignment_configuration: Optional[CapacityReservationCapacityAssignmentConfigurationArgs] = None,
                        name: Optional[str] = None,
                        tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCapacityReservation(ctx *Context, name string, args CapacityReservationArgs, opts ...ResourceOption) (*CapacityReservation, error)
    public CapacityReservation(string name, CapacityReservationArgs args, CustomResourceOptions? opts = null)
    public CapacityReservation(String name, CapacityReservationArgs args)
public CapacityReservation(String name, CapacityReservationArgs args, CustomResourceOptions options)

    type: aws-native:athena:CapacityReservation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    CapacityReservation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CapacityReservation resource accepts the following input properties:

    TargetDpus int
    The number of DPUs to request to be allocated to the reservation.
    CapacityAssignmentConfiguration Pulumi.AwsNative.Athena.Inputs.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.
    Name string
    The reservation name.
    Tags List<Pulumi.AwsNative.Inputs.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.
    CapacityAssignmentConfiguration CapacityReservationCapacityAssignmentConfigurationArgs
    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.
    Name string
    The reservation name.
    Tags TagArgs
    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.
    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.
    name String
    The reservation name.
    tags List<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.
    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.
    name string
    The reservation name.
    tags 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.
    capacity_assignment_configuration CapacityReservationCapacityAssignmentConfigurationArgs
    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.
    name str
    The reservation name.
    tags Sequence[TagArgs]
    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.
    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.
    name String
    The reservation name.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CapacityReservation resource produces the following output properties:

    AllocatedDpus int
    The number of DPUs Athena has provisioned and allocated for the reservation
    Arn string
    The ARN of the capacity reservation.
    CreationTime string
    The date and time the reservation was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSuccessfulAllocationTime string
    The timestamp when the last successful allocated was made
    Status Pulumi.AwsNative.Athena.CapacityReservationStatus
    The status of the reservation.
    AllocatedDpus int
    The number of DPUs Athena has provisioned and allocated for the reservation
    Arn string
    The ARN of the capacity reservation.
    CreationTime string
    The date and time the reservation was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSuccessfulAllocationTime string
    The timestamp when the last successful allocated was made
    Status CapacityReservationStatus
    The status of the reservation.
    allocatedDpus Integer
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn String
    The ARN of the capacity reservation.
    creationTime String
    The date and time the reservation was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulAllocationTime String
    The timestamp when the last successful allocated was made
    status CapacityReservationStatus
    The status of the reservation.
    allocatedDpus number
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn string
    The ARN of the capacity reservation.
    creationTime string
    The date and time the reservation was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulAllocationTime string
    The timestamp when the last successful allocated was made
    status CapacityReservationStatus
    The status of 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.
    creation_time str
    The date and time the reservation was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_successful_allocation_time str
    The timestamp when the last successful allocated was made
    status CapacityReservationStatus
    The status of the reservation.
    allocatedDpus Number
    The number of DPUs Athena has provisioned and allocated for the reservation
    arn String
    The ARN of the capacity reservation.
    creationTime String
    The date and time the reservation was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulAllocationTime String
    The timestamp when the last successful allocated was made
    status "PENDING" | "ACTIVE" | "CANCELLING" | "CANCELLED" | "FAILED" | "UPDATE_PENDING"
    The status of the reservation.

    Supporting Types

    CapacityReservationCapacityAssignment, CapacityReservationCapacityAssignmentArgs

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

    CapacityReservationCapacityAssignmentConfiguration, CapacityReservationCapacityAssignmentConfigurationArgs

    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, CapacityReservationStatusArgs

    Pending
    PENDING
    Active
    ACTIVE
    Cancelling
    CANCELLING
    Cancelled
    CANCELLED
    Failed
    FAILED
    UpdatePending
    UPDATE_PENDING
    CapacityReservationStatusPending
    PENDING
    CapacityReservationStatusActive
    ACTIVE
    CapacityReservationStatusCancelling
    CANCELLING
    CapacityReservationStatusCancelled
    CANCELLED
    CapacityReservationStatusFailed
    FAILED
    CapacityReservationStatusUpdatePending
    UPDATE_PENDING
    Pending
    PENDING
    Active
    ACTIVE
    Cancelling
    CANCELLING
    Cancelled
    CANCELLED
    Failed
    FAILED
    UpdatePending
    UPDATE_PENDING
    Pending
    PENDING
    Active
    ACTIVE
    Cancelling
    CANCELLING
    Cancelled
    CANCELLED
    Failed
    FAILED
    UpdatePending
    UPDATE_PENDING
    PENDING
    PENDING
    ACTIVE
    ACTIVE
    CANCELLING
    CANCELLING
    CANCELLED
    CANCELLED
    FAILED
    FAILED
    UPDATE_PENDING
    UPDATE_PENDING
    "PENDING"
    PENDING
    "ACTIVE"
    ACTIVE
    "CANCELLING"
    CANCELLING
    "CANCELLED"
    CANCELLED
    "FAILED"
    FAILED
    "UPDATE_PENDING"
    UPDATE_PENDING

    Tag, TagArgs

    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