CfnBudgetPropsMixin

class aws_cdk.cfn_property_mixins.aws_deadline.CfnBudgetPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a budget to set spending thresholds for your rendering activity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-budget.html
CloudformationResource:: AWS::Deadline::Budget
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.cfn_property_mixins import aws_deadline as deadline
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_budget_props_mixin = deadline.CfnBudgetPropsMixin(deadline.CfnBudgetMixinProps(
    actions=[deadline.CfnBudgetPropsMixin.BudgetActionToAddProperty(
        description="description",
        threshold_percentage=123,
        type="type"
    )],
    approximate_dollar_limit=123,
    description="description",
    display_name="displayName",
    farm_id="farmId",
    schedule=deadline.CfnBudgetPropsMixin.BudgetScheduleProperty(
        fixed=deadline.CfnBudgetPropsMixin.FixedBudgetScheduleProperty(
            end_time="endTime",
            start_time="startTime"
        )
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    usage_tracking_resource=deadline.CfnBudgetPropsMixin.UsageTrackingResourceProperty(
        queue_id="queueId"
    )
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Deadline::Budget.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['actions', 'approximateDollarLimit', 'description', 'displayName', 'farmId', 'schedule', 'tags', 'usageTrackingResource']

Static Methods

classmethod is_mixin(x)

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.

BudgetActionToAddProperty

class CfnBudgetPropsMixin.BudgetActionToAddProperty(*, description=None, threshold_percentage=None, type=None)

Bases: object

The budget action to add.

Parameters:

description (Optional[str]) – A description for the budget action.
threshold_percentage (Union[int, float, None]) – The percentage threshold for the budget action.
type (Optional[str]) – The type of budget action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-budgetactiontoadd.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.cfn_property_mixins import aws_deadline as deadline

budget_action_to_add_property = deadline.CfnBudgetPropsMixin.BudgetActionToAddProperty(
    description="description",
    threshold_percentage=123,
    type="type"
)

Attributes

description

A description for the budget action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-budgetactiontoadd.html#cfn-deadline-budget-budgetactiontoadd-description

threshold_percentage

The percentage threshold for the budget action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-budgetactiontoadd.html#cfn-deadline-budget-budgetactiontoadd-thresholdpercentage

type

The type of budget action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-budgetactiontoadd.html#cfn-deadline-budget-budgetactiontoadd-type

BudgetScheduleProperty

class CfnBudgetPropsMixin.BudgetScheduleProperty(*, fixed=None)

Bases: object

The start and end time of the budget.

Parameters:: fixed (Union[IResolvable, FixedBudgetScheduleProperty, Dict[str, Any], None]) – The details of a fixed budget schedule.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-budgetschedule.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.cfn_property_mixins import aws_deadline as deadline

budget_schedule_property = deadline.CfnBudgetPropsMixin.BudgetScheduleProperty(
    fixed=deadline.CfnBudgetPropsMixin.FixedBudgetScheduleProperty(
        end_time="endTime",
        start_time="startTime"
    )
)

Attributes

fixed

The details of a fixed budget schedule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-budgetschedule.html#cfn-deadline-budget-budgetschedule-fixed

FixedBudgetScheduleProperty

class CfnBudgetPropsMixin.FixedBudgetScheduleProperty(*, end_time=None, start_time=None)

Bases: object

The details of a fixed budget schedule.

Parameters:

end_time (Optional[str]) – When the budget ends.
start_time (Optional[str]) – When the budget starts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-fixedbudgetschedule.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.cfn_property_mixins import aws_deadline as deadline

fixed_budget_schedule_property = deadline.CfnBudgetPropsMixin.FixedBudgetScheduleProperty(
    end_time="endTime",
    start_time="startTime"
)

Attributes

end_time

When the budget ends.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-fixedbudgetschedule.html#cfn-deadline-budget-fixedbudgetschedule-endtime

start_time

When the budget starts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-fixedbudgetschedule.html#cfn-deadline-budget-fixedbudgetschedule-starttime

UsageTrackingResourceProperty

class CfnBudgetPropsMixin.UsageTrackingResourceProperty(*, queue_id=None)

Bases: object

The usage details of the allotted budget.

Parameters:: queue_id (Optional[str]) – The queue ID.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-usagetrackingresource.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.cfn_property_mixins import aws_deadline as deadline

usage_tracking_resource_property = deadline.CfnBudgetPropsMixin.UsageTrackingResourceProperty(
    queue_id="queueId"
)

Attributes

queue_id

The queue ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-budget-usagetrackingresource.html#cfn-deadline-budget-usagetrackingresource-queueid