Package software.amazon.awscdk.services.athena

Interface CfnCapacityReservationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCapacityReservationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:04.540Z")
@Stability(Stable)
public interface CfnCapacityReservationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCapacityReservation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.athena.*;
 CfnCapacityReservationProps cfnCapacityReservationProps = CfnCapacityReservationProps.builder()
         .name("name")
         .targetDpus(123)
         // the properties below are optional
         .capacityAssignmentConfiguration(CapacityAssignmentConfigurationProperty.builder()
                 .capacityAssignments(List.of(CapacityAssignmentProperty.builder()
                         .workgroupNames(List.of("workgroupNames"))
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCapacityReservationProps.Builder	A builder for CfnCapacityReservationProps
static final class	CfnCapacityReservationProps.Jsii$Proxy	An implementation for CfnCapacityReservationProps

Method Summary

Modifier and Type	Method	Description
static CfnCapacityReservationProps.Builder	builder()
default Object	getCapacityAssignmentConfiguration()	Assigns Athena workgroups (and hence their queries) to capacity reservations.
String	getName()	The name of the capacity reservation.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to the capacity reservation.
Number	getTargetDpus()	The number of data processing units requested.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the capacity reservation.

See Also:

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

getTargetDpus

@Stability(Stable)
@NotNull
Number getTargetDpus()

The number of data processing units requested.

See Also:

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

getCapacityAssignmentConfiguration

@Stability(Stable)
@Nullable
default Object getCapacityAssignmentConfiguration()

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 Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnCapacityReservationProps.Builder builder()

Returns:

a CfnCapacityReservationProps.Builder of CfnCapacityReservationProps