CfnCapacityReservationProps

class aws_cdk.aws_athena.CfnCapacityReservationProps(*, name, target_dpus, capacity_assignment_configuration=None, tags=None)

Bases: object

Properties for defining a CfnCapacityReservation.

Parameters:

  • name (str) – The name of the capacity reservation.

  • target_dpus (Union[int, float]) – The number of data processing units requested.

  • capacity_assignment_configuration (Union[IResolvable, CapacityAssignmentConfigurationProperty, Dict[str, Any], None]) – 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.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to the capacity reservation. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_athena as athena

cfn_capacity_reservation_props = athena.CfnCapacityReservationProps(
    name="name",
    target_dpus=123,

    # the properties below are optional
    capacity_assignment_configuration=athena.CfnCapacityReservation.CapacityAssignmentConfigurationProperty(
        capacity_assignments=[athena.CfnCapacityReservation.CapacityAssignmentProperty(
            workgroup_names=["workgroupNames"]
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

capacity_assignment_configuration

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-capacityassignmentconfiguration

name

The name of the capacity reservation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-name

tags

An array of key-value pairs to apply to the capacity reservation.

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-tags

target_dpus

The number of data processing units requested.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html#cfn-athena-capacityreservation-targetdpus