CfnPlanMixinProps

class aws_cdk.mixins_preview.aws_arcregionswitch.mixins.CfnPlanMixinProps(*, associated_alarms=None, description=None, execution_role=None, name=None, primary_region=None, recovery_approach=None, recovery_time_objective_minutes=None, regions=None, tags=None, triggers=None, workflows=None)

Bases: object

Properties for CfnPlanPropsMixin.

Parameters:
  • associated_alarms (Union[IResolvable, Mapping[str, Union[IResolvable, AssociatedAlarmProperty, Dict[str, Any]]], None]) – The associated application health alarms for a plan.

  • description (Optional[str]) – The description for a plan.

  • execution_role (Optional[str]) – The execution role for a plan.

  • name (Optional[str]) – The name for a plan.

  • primary_region (Optional[str]) – The primary Region for a plan.

  • recovery_approach (Optional[str]) – The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

  • recovery_time_objective_minutes (Union[int, float, None]) – The recovery time objective for a plan.

  • regions (Optional[Sequence[str]]) – The AWS Regions for a plan.

  • tags (Optional[Mapping[str, str]])

  • triggers (Union[IResolvable, Sequence[Union[IResolvable, TriggerProperty, Dict[str, Any]]], None]) – The triggers for a plan.

  • workflows (Union[IResolvable, Sequence[Union[IResolvable, WorkflowProperty, Dict[str, Any]]], None]) – The workflows for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.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_arcregionswitch import mixins as arcregionswitch_mixins

# step_property_: arcregionswitch_mixins.CfnPlanPropsMixin.StepProperty

cfn_plan_mixin_props = arcregionswitch_mixins.CfnPlanMixinProps(
    associated_alarms={
        "associated_alarms_key": arcregionswitch_mixins.CfnPlanPropsMixin.AssociatedAlarmProperty(
            alarm_type="alarmType",
            cross_account_role="crossAccountRole",
            external_id="externalId",
            resource_identifier="resourceIdentifier"
        )
    },
    description="description",
    execution_role="executionRole",
    name="name",
    primary_region="primaryRegion",
    recovery_approach="recoveryApproach",
    recovery_time_objective_minutes=123,
    regions=["regions"],
    tags={
        "tags_key": "tags"
    },
    triggers=[arcregionswitch_mixins.CfnPlanPropsMixin.TriggerProperty(
        action="action",
        conditions=[arcregionswitch_mixins.CfnPlanPropsMixin.TriggerConditionProperty(
            associated_alarm_name="associatedAlarmName",
            condition="condition"
        )],
        description="description",
        min_delay_minutes_between_executions=123,
        target_region="targetRegion"
    )],
    workflows=[arcregionswitch_mixins.CfnPlanPropsMixin.WorkflowProperty(
        steps=[arcregionswitch_mixins.CfnPlanPropsMixin.StepProperty(
            description="description",
            execution_block_configuration=arcregionswitch_mixins.CfnPlanPropsMixin.ExecutionBlockConfigurationProperty(
                arc_routing_control_config=arcregionswitch_mixins.CfnPlanPropsMixin.ArcRoutingControlConfigurationProperty(
                    cross_account_role="crossAccountRole",
                    external_id="externalId",
                    region_and_routing_controls={
                        "region_and_routing_controls_key": [arcregionswitch_mixins.CfnPlanPropsMixin.ArcRoutingControlStateProperty(
                            routing_control_arn="routingControlArn",
                            state="state"
                        )]
                    },
                    timeout_minutes=123
                ),
                custom_action_lambda_config=arcregionswitch_mixins.CfnPlanPropsMixin.CustomActionLambdaConfigurationProperty(
                    lambdas=[arcregionswitch_mixins.CfnPlanPropsMixin.LambdasProperty(
                        arn="arn",
                        cross_account_role="crossAccountRole",
                        external_id="externalId"
                    )],
                    region_to_run="regionToRun",
                    retry_interval_minutes=123,
                    timeout_minutes=123,
                    ungraceful=arcregionswitch_mixins.CfnPlanPropsMixin.LambdaUngracefulProperty(
                        behavior="behavior"
                    )
                ),
                ec2_asg_capacity_increase_config=arcregionswitch_mixins.CfnPlanPropsMixin.Ec2AsgCapacityIncreaseConfigurationProperty(
                    asgs=[arcregionswitch_mixins.CfnPlanPropsMixin.AsgProperty(
                        arn="arn",
                        cross_account_role="crossAccountRole",
                        external_id="externalId"
                    )],
                    capacity_monitoring_approach="capacityMonitoringApproach",
                    target_percent=123,
                    timeout_minutes=123,
                    ungraceful=arcregionswitch_mixins.CfnPlanPropsMixin.Ec2UngracefulProperty(
                        minimum_success_percentage=123
                    )
                ),
                ecs_capacity_increase_config=arcregionswitch_mixins.CfnPlanPropsMixin.EcsCapacityIncreaseConfigurationProperty(
                    capacity_monitoring_approach="capacityMonitoringApproach",
                    services=[arcregionswitch_mixins.CfnPlanPropsMixin.ServiceProperty(
                        cluster_arn="clusterArn",
                        cross_account_role="crossAccountRole",
                        external_id="externalId",
                        service_arn="serviceArn"
                    )],
                    target_percent=123,
                    timeout_minutes=123,
                    ungraceful=arcregionswitch_mixins.CfnPlanPropsMixin.EcsUngracefulProperty(
                        minimum_success_percentage=123
                    )
                ),
                eks_resource_scaling_config=arcregionswitch_mixins.CfnPlanPropsMixin.EksResourceScalingConfigurationProperty(
                    capacity_monitoring_approach="capacityMonitoringApproach",
                    eks_clusters=[arcregionswitch_mixins.CfnPlanPropsMixin.EksClusterProperty(
                        cluster_arn="clusterArn",
                        cross_account_role="crossAccountRole",
                        external_id="externalId"
                    )],
                    kubernetes_resource_type=arcregionswitch_mixins.CfnPlanPropsMixin.KubernetesResourceTypeProperty(
                        api_version="apiVersion",
                        kind="kind"
                    ),
                    scaling_resources=[{
                        "scaling_resources_key": {
                            "scaling_resources_key": arcregionswitch_mixins.CfnPlanPropsMixin.KubernetesScalingResourceProperty(
                                hpa_name="hpaName",
                                name="name",
                                namespace="namespace"
                            )
                        }
                    }],
                    target_percent=123,
                    timeout_minutes=123,
                    ungraceful=arcregionswitch_mixins.CfnPlanPropsMixin.EksResourceScalingUngracefulProperty(
                        minimum_success_percentage=123
                    )
                ),
                execution_approval_config=arcregionswitch_mixins.CfnPlanPropsMixin.ExecutionApprovalConfigurationProperty(
                    approval_role="approvalRole",
                    timeout_minutes=123
                ),
                global_aurora_config=arcregionswitch_mixins.CfnPlanPropsMixin.GlobalAuroraConfigurationProperty(
                    behavior="behavior",
                    cross_account_role="crossAccountRole",
                    database_cluster_arns=["databaseClusterArns"],
                    external_id="externalId",
                    global_cluster_identifier="globalClusterIdentifier",
                    timeout_minutes=123,
                    ungraceful=arcregionswitch_mixins.CfnPlanPropsMixin.GlobalAuroraUngracefulProperty(
                        ungraceful="ungraceful"
                    )
                ),
                parallel_config=arcregionswitch_mixins.CfnPlanPropsMixin.ParallelExecutionBlockConfigurationProperty(
                    steps=[step_property_]
                ),
                region_switch_plan_config=arcregionswitch_mixins.CfnPlanPropsMixin.RegionSwitchPlanConfigurationProperty(
                    arn="arn",
                    cross_account_role="crossAccountRole",
                    external_id="externalId"
                ),
                route53_health_check_config=arcregionswitch_mixins.CfnPlanPropsMixin.Route53HealthCheckConfigurationProperty(
                    cross_account_role="crossAccountRole",
                    external_id="externalId",
                    hosted_zone_id="hostedZoneId",
                    record_name="recordName",
                    record_sets=[arcregionswitch_mixins.CfnPlanPropsMixin.Route53ResourceRecordSetProperty(
                        record_set_identifier="recordSetIdentifier",
                        region="region"
                    )],
                    timeout_minutes=123
                )
            ),
            execution_block_type="executionBlockType",
            name="name"
        )],
        workflow_description="workflowDescription",
        workflow_target_action="workflowTargetAction",
        workflow_target_region="workflowTargetRegion"
    )]
)

Attributes

associated_alarms

The associated application health alarms for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-associatedalarms

description

The description for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-description

execution_role

The execution role for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-executionrole

name

The name for a plan.

See:

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

primary_region

The primary Region for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-primaryregion

recovery_approach

The recovery approach for a Region switch plan, which can be active/active (activeActive) or active/passive (activePassive).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoveryapproach

recovery_time_objective_minutes

The recovery time objective for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-recoverytimeobjectiveminutes

regions

The AWS Regions for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-regions

tags

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

Type:

see

triggers

The triggers for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-triggers

workflows

The workflows for a plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html#cfn-arcregionswitch-plan-workflows