CfnCapacityReservationPropsMixin

class aws_cdk.mixins_preview.aws_athena.mixins.CfnCapacityReservationPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a capacity reservation with the provided name and number of requested data processing units.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-athena-capacityreservation.html
CloudformationResource:: AWS::Athena::CapacityReservation
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_athena import mixins as athena_mixins

cfn_capacity_reservation_props_mixin = athena_mixins.CfnCapacityReservationPropsMixin(athena_mixins.CfnCapacityReservationMixinProps(
    capacity_assignment_configuration=athena_mixins.CfnCapacityReservationPropsMixin.CapacityAssignmentConfigurationProperty(
        capacity_assignments=[athena_mixins.CfnCapacityReservationPropsMixin.CapacityAssignmentProperty(
            workgroup_names=["workgroupNames"]
        )]
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_dpus=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Athena::CapacityReservation.

Parameters:

props (Union[CfnCapacityReservationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['capacityAssignmentConfiguration', 'name', 'tags', 'targetDpus']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CapacityAssignmentConfigurationProperty

class CfnCapacityReservationPropsMixin.CapacityAssignmentConfigurationProperty(*, capacity_assignments=None)

Bases: object

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.

Parameters:: capacity_assignments (Union[IResolvable, Sequence[Union[IResolvable, CapacityAssignmentProperty, Dict[str, Any]]], None]) – The list of assignments that make up the capacity assignment configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignmentconfiguration.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.mixins_preview.aws_athena import mixins as athena_mixins

capacity_assignment_configuration_property = athena_mixins.CfnCapacityReservationPropsMixin.CapacityAssignmentConfigurationProperty(
    capacity_assignments=[athena_mixins.CfnCapacityReservationPropsMixin.CapacityAssignmentProperty(
        workgroup_names=["workgroupNames"]
    )]
)

Attributes

capacity_assignments

The list of assignments that make up the capacity assignment configuration.

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

CapacityAssignmentProperty

class CfnCapacityReservationPropsMixin.CapacityAssignmentProperty(*, workgroup_names=None)

Bases: object

A mapping between one or more workgroups and a capacity reservation.

Parameters:: workgroup_names (Optional[Sequence[str]]) – The list of workgroup names for the capacity assignment.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignment.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.mixins_preview.aws_athena import mixins as athena_mixins

capacity_assignment_property = athena_mixins.CfnCapacityReservationPropsMixin.CapacityAssignmentProperty(
    workgroup_names=["workgroupNames"]
)

Attributes

workgroup_names

The list of workgroup names for the capacity assignment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-athena-capacityreservation-capacityassignment.html#cfn-athena-capacityreservation-capacityassignment-workgroupnames