CfnAutomationRulePropsMixin

class aws_cdk.cfn_property_mixins.aws_computeoptimizer.CfnAutomationRulePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an AWS Compute Optimizer automation rule that automatically implements recommended actions based on your defined criteria and schedule.

Automation rules are global resources that manage automated actions across all AWS Regions where Compute Optimizer Automation is available. Organization-level rules can only be created by the management account or delegated administrator.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-computeoptimizer-automationrule.html
CloudformationResource:: AWS::ComputeOptimizer::AutomationRule
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_computeoptimizer as computeoptimizer
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_automation_rule_props_mixin = computeoptimizer.CfnAutomationRulePropsMixin(computeoptimizer.CfnAutomationRuleMixinProps(
    criteria=computeoptimizer.CfnAutomationRulePropsMixin.CriteriaProperty(
        ebs_volume_size_in_gib=[computeoptimizer.CfnAutomationRulePropsMixin.IntegerCriteriaConditionProperty(
            comparison="comparison",
            values=[123]
        )],
        ebs_volume_type=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
            comparison="comparison",
            values=["values"]
        )],
        estimated_monthly_savings=[computeoptimizer.CfnAutomationRulePropsMixin.DoubleCriteriaConditionProperty(
            comparison="comparison",
            values=[123]
        )],
        look_back_period_in_days=[computeoptimizer.CfnAutomationRulePropsMixin.IntegerCriteriaConditionProperty(
            comparison="comparison",
            values=[123]
        )],
        region=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
            comparison="comparison",
            values=["values"]
        )],
        resource_arn=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
            comparison="comparison",
            values=["values"]
        )],
        resource_tag=[computeoptimizer.CfnAutomationRulePropsMixin.ResourceTagsCriteriaConditionProperty(
            comparison="comparison",
            key="key",
            values=["values"]
        )],
        restart_needed=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
            comparison="comparison",
            values=["values"]
        )]
    ),
    description="description",
    name="name",
    organization_configuration=computeoptimizer.CfnAutomationRulePropsMixin.OrganizationConfigurationProperty(
        account_ids=["accountIds"],
        rule_apply_order="ruleApplyOrder"
    ),
    priority="priority",
    recommended_action_types=["recommendedActionTypes"],
    rule_type="ruleType",
    schedule=computeoptimizer.CfnAutomationRulePropsMixin.ScheduleProperty(
        execution_window_in_minutes=123,
        schedule_expression="scheduleExpression",
        schedule_expression_timezone="scheduleExpressionTimezone"
    ),
    status="status",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::ComputeOptimizer::AutomationRule.

Parameters:

props (Union[CfnAutomationRuleMixinProps, 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 = ['criteria', 'description', 'name', 'organizationConfiguration', 'priority', 'recommendedActionTypes', 'ruleType', 'schedule', 'status', 'tags']

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.

CriteriaProperty

class CfnAutomationRulePropsMixin.CriteriaProperty(*, ebs_volume_size_in_gib=None, ebs_volume_type=None, estimated_monthly_savings=None, look_back_period_in_days=None, region=None, resource_arn=None, resource_tag=None, restart_needed=None)

Bases: object

Parameters:

ebs_volume_size_in_gib (Union[IResolvable, Sequence[Union[IResolvable, IntegerCriteriaConditionProperty, Dict[str, Any]]], None])
ebs_volume_type (Union[IResolvable, Sequence[Union[IResolvable, StringCriteriaConditionProperty, Dict[str, Any]]], None])
estimated_monthly_savings (Union[IResolvable, Sequence[Union[IResolvable, DoubleCriteriaConditionProperty, Dict[str, Any]]], None])
look_back_period_in_days (Union[IResolvable, Sequence[Union[IResolvable, IntegerCriteriaConditionProperty, Dict[str, Any]]], None])
region (Union[IResolvable, Sequence[Union[IResolvable, StringCriteriaConditionProperty, Dict[str, Any]]], None])
resource_arn (Union[IResolvable, Sequence[Union[IResolvable, StringCriteriaConditionProperty, Dict[str, Any]]], None])
resource_tag (Union[IResolvable, Sequence[Union[IResolvable, ResourceTagsCriteriaConditionProperty, Dict[str, Any]]], None])
restart_needed (Union[IResolvable, Sequence[Union[IResolvable, StringCriteriaConditionProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.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_computeoptimizer as computeoptimizer

criteria_property = computeoptimizer.CfnAutomationRulePropsMixin.CriteriaProperty(
    ebs_volume_size_in_gib=[computeoptimizer.CfnAutomationRulePropsMixin.IntegerCriteriaConditionProperty(
        comparison="comparison",
        values=[123]
    )],
    ebs_volume_type=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
        comparison="comparison",
        values=["values"]
    )],
    estimated_monthly_savings=[computeoptimizer.CfnAutomationRulePropsMixin.DoubleCriteriaConditionProperty(
        comparison="comparison",
        values=[123]
    )],
    look_back_period_in_days=[computeoptimizer.CfnAutomationRulePropsMixin.IntegerCriteriaConditionProperty(
        comparison="comparison",
        values=[123]
    )],
    region=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
        comparison="comparison",
        values=["values"]
    )],
    resource_arn=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
        comparison="comparison",
        values=["values"]
    )],
    resource_tag=[computeoptimizer.CfnAutomationRulePropsMixin.ResourceTagsCriteriaConditionProperty(
        comparison="comparison",
        key="key",
        values=["values"]
    )],
    restart_needed=[computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
        comparison="comparison",
        values=["values"]
    )]
)

Attributes

ebs_volume_size_in_gib

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-ebsvolumesizeingib

Type:: see

ebs_volume_type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-ebsvolumetype

Type:: see

estimated_monthly_savings

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-estimatedmonthlysavings

Type:: see

look_back_period_in_days

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-lookbackperiodindays

Type:: see

region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-region

Type:: see

resource_arn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-resourcearn

Type:: see

resource_tag

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-resourcetag

Type:: see

restart_needed

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-criteria.html#cfn-computeoptimizer-automationrule-criteria-restartneeded

Type:: see

DoubleCriteriaConditionProperty

class CfnAutomationRulePropsMixin.DoubleCriteriaConditionProperty(*, comparison=None, values=None)

Bases: object

Parameters:

comparison (Optional[str])
values (Union[Sequence[Union[int, float]], IResolvable, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-doublecriteriacondition.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_computeoptimizer as computeoptimizer

double_criteria_condition_property = computeoptimizer.CfnAutomationRulePropsMixin.DoubleCriteriaConditionProperty(
    comparison="comparison",
    values=[123]
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-doublecriteriacondition.html#cfn-computeoptimizer-automationrule-doublecriteriacondition-comparison

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-doublecriteriacondition.html#cfn-computeoptimizer-automationrule-doublecriteriacondition-values

Type:: see

IntegerCriteriaConditionProperty

class CfnAutomationRulePropsMixin.IntegerCriteriaConditionProperty(*, comparison=None, values=None)

Bases: object

Parameters:

comparison (Optional[str])
values (Union[Sequence[Union[int, float]], IResolvable, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-integercriteriacondition.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_computeoptimizer as computeoptimizer

integer_criteria_condition_property = computeoptimizer.CfnAutomationRulePropsMixin.IntegerCriteriaConditionProperty(
    comparison="comparison",
    values=[123]
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-integercriteriacondition.html#cfn-computeoptimizer-automationrule-integercriteriacondition-comparison

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-integercriteriacondition.html#cfn-computeoptimizer-automationrule-integercriteriacondition-values

Type:: see

OrganizationConfigurationProperty

class CfnAutomationRulePropsMixin.OrganizationConfigurationProperty(*, account_ids=None, rule_apply_order=None)

Bases: object

Parameters:

account_ids (Optional[Sequence[str]]) – List of account IDs where the organization rule applies.
rule_apply_order (Optional[str]) – When the rule should be applied relative to account rules.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-organizationconfiguration.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_computeoptimizer as computeoptimizer

organization_configuration_property = computeoptimizer.CfnAutomationRulePropsMixin.OrganizationConfigurationProperty(
    account_ids=["accountIds"],
    rule_apply_order="ruleApplyOrder"
)

Attributes

account_ids

List of account IDs where the organization rule applies.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-organizationconfiguration.html#cfn-computeoptimizer-automationrule-organizationconfiguration-accountids

rule_apply_order

When the rule should be applied relative to account rules.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-organizationconfiguration.html#cfn-computeoptimizer-automationrule-organizationconfiguration-ruleapplyorder

ResourceTagsCriteriaConditionProperty

class CfnAutomationRulePropsMixin.ResourceTagsCriteriaConditionProperty(*, comparison=None, key=None, values=None)

Bases: object

Parameters:

comparison (Optional[str])
key (Optional[str])
values (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-resourcetagscriteriacondition.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_computeoptimizer as computeoptimizer

resource_tags_criteria_condition_property = computeoptimizer.CfnAutomationRulePropsMixin.ResourceTagsCriteriaConditionProperty(
    comparison="comparison",
    key="key",
    values=["values"]
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-resourcetagscriteriacondition.html#cfn-computeoptimizer-automationrule-resourcetagscriteriacondition-comparison

Type:: see

key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-resourcetagscriteriacondition.html#cfn-computeoptimizer-automationrule-resourcetagscriteriacondition-key

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-resourcetagscriteriacondition.html#cfn-computeoptimizer-automationrule-resourcetagscriteriacondition-values

Type:: see

ScheduleProperty

class CfnAutomationRulePropsMixin.ScheduleProperty(*, execution_window_in_minutes=None, schedule_expression=None, schedule_expression_timezone=None)

Bases: object

Parameters:

execution_window_in_minutes (Union[int, float, None]) – Execution window duration in minutes.
schedule_expression (Optional[str]) – Schedule expression (e.g., cron or rate expression).
schedule_expression_timezone (Optional[str]) – IANA timezone identifier.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-schedule.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_computeoptimizer as computeoptimizer

schedule_property = computeoptimizer.CfnAutomationRulePropsMixin.ScheduleProperty(
    execution_window_in_minutes=123,
    schedule_expression="scheduleExpression",
    schedule_expression_timezone="scheduleExpressionTimezone"
)

Attributes

execution_window_in_minutes

Execution window duration in minutes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-schedule.html#cfn-computeoptimizer-automationrule-schedule-executionwindowinminutes

schedule_expression

Schedule expression (e.g., cron or rate expression).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-schedule.html#cfn-computeoptimizer-automationrule-schedule-scheduleexpression

schedule_expression_timezone

IANA timezone identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-schedule.html#cfn-computeoptimizer-automationrule-schedule-scheduleexpressiontimezone

StringCriteriaConditionProperty

class CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(*, comparison=None, values=None)

Bases: object

Parameters:

comparison (Optional[str])
values (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-stringcriteriacondition.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_computeoptimizer as computeoptimizer

string_criteria_condition_property = computeoptimizer.CfnAutomationRulePropsMixin.StringCriteriaConditionProperty(
    comparison="comparison",
    values=["values"]
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-stringcriteriacondition.html#cfn-computeoptimizer-automationrule-stringcriteriacondition-comparison

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-computeoptimizer-automationrule-stringcriteriacondition.html#cfn-computeoptimizer-automationrule-stringcriteriacondition-values

Type:: see