CfnPlanPropsMixin
- class aws_cdk.mixins_preview.aws_arcregionswitch.mixins.CfnPlanPropsMixin(props, *, strategy=None)
Bases:
MixinRepresents a Region switch plan.
A plan defines the steps required to shift traffic from one AWS Region to another.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-arcregionswitch-plan.html
- CloudformationResource:
AWS::ARCRegionSwitch::Plan
- 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_arcregionswitch import mixins as arcregionswitch_mixins # step_property_: arcregionswitch_mixins.CfnPlanPropsMixin.StepProperty cfn_plan_props_mixin = arcregionswitch_mixins.CfnPlanPropsMixin(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" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::ARCRegionSwitch::Plan.- Parameters:
props (
Union[CfnPlanMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['associatedAlarms', 'description', 'executionRole', 'name', 'primaryRegion', 'recoveryApproach', 'recoveryTimeObjectiveMinutes', 'regions', 'tags', 'triggers', 'workflows']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
ArcRoutingControlConfigurationProperty
- class CfnPlanPropsMixin.ArcRoutingControlConfigurationProperty(*, cross_account_role=None, external_id=None, region_and_routing_controls=None, timeout_minutes=None)
Bases:
objectConfiguration for ARC routing controls used in a Region switch plan.
Routing controls are simple on/off switches that you can use to shift traffic away from an impaired Region.
- Parameters:
cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.region_and_routing_controls (
Union[IResolvable,Mapping[str,Union[IResolvable,Sequence[Union[IResolvable,ArcRoutingControlStateProperty,Dict[str,Any]]]]],None]) – The Region and ARC routing controls for the configuration.timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60
- See:
- 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 arc_routing_control_configuration_property = 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 )
Attributes
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
- region_and_routing_controls
The Region and ARC routing controls for the configuration.
- timeout_minutes
The timeout value specified for the configuration.
ArcRoutingControlStateProperty
- class CfnPlanPropsMixin.ArcRoutingControlStateProperty(*, routing_control_arn=None, state=None)
Bases:
object- Parameters:
routing_control_arn (
Optional[str])state (
Optional[str])
- See:
- 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 arc_routing_control_state_property = arcregionswitch_mixins.CfnPlanPropsMixin.ArcRoutingControlStateProperty( routing_control_arn="routingControlArn", state="state" )
Attributes
- routing_control_arn
-
- Type:
see
AsgProperty
- class CfnPlanPropsMixin.AsgProperty(*, arn=None, cross_account_role=None, external_id=None)
Bases:
objectConfiguration for an Amazon EC2 Auto Scaling group used in a Region switch plan.
- Parameters:
arn (
Optional[str]) – The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.
- See:
- 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 asg_property = arcregionswitch_mixins.CfnPlanPropsMixin.AsgProperty( arn="arn", cross_account_role="crossAccountRole", external_id="externalId" )
Attributes
- arn
The Amazon Resource Name (ARN) of the EC2 Auto Scaling group.
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
AssociatedAlarmProperty
- class CfnPlanPropsMixin.AssociatedAlarmProperty(*, alarm_type=None, cross_account_role=None, external_id=None, resource_identifier=None)
Bases:
objectAn Amazon CloudWatch alarm associated with a Region switch plan.
These alarms can be used to trigger automatic execution of the plan.
- Parameters:
alarm_type (
Optional[str]) – The alarm type for an associated alarm. An associated CloudWatch alarm can be an application health alarm or a trigger alarm.cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.resource_identifier (
Optional[str]) – The resource identifier for alarms that you associate with a plan.
- See:
- 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 associated_alarm_property = arcregionswitch_mixins.CfnPlanPropsMixin.AssociatedAlarmProperty( alarm_type="alarmType", cross_account_role="crossAccountRole", external_id="externalId", resource_identifier="resourceIdentifier" )
Attributes
- alarm_type
The alarm type for an associated alarm.
An associated CloudWatch alarm can be an application health alarm or a trigger alarm.
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
- resource_identifier
The resource identifier for alarms that you associate with a plan.
CustomActionLambdaConfigurationProperty
- class CfnPlanPropsMixin.CustomActionLambdaConfigurationProperty(*, lambdas=None, region_to_run=None, retry_interval_minutes=None, timeout_minutes=None, ungraceful=None)
Bases:
objectConfiguration for AWS Lambda functions that perform custom actions during a Region switch.
- Parameters:
lambdas (
Union[IResolvable,Sequence[Union[IResolvable,LambdasProperty,Dict[str,Any]]],None]) – The AWS Lambda functions for the execution block.region_to_run (
Optional[str]) – The AWS Region for the function to run in.retry_interval_minutes (
Union[int,float,None]) – The retry interval specified.timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60ungraceful (
Union[IResolvable,LambdaUngracefulProperty,Dict[str,Any],None]) – The settings for ungraceful execution.
- See:
- 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 custom_action_lambda_configuration_property = 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" ) )
Attributes
- lambdas
The AWS Lambda functions for the execution block.
- region_to_run
The AWS Region for the function to run in.
- retry_interval_minutes
The retry interval specified.
- timeout_minutes
The timeout value specified for the configuration.
- ungraceful
The settings for ungraceful execution.
Ec2AsgCapacityIncreaseConfigurationProperty
- class CfnPlanPropsMixin.Ec2AsgCapacityIncreaseConfigurationProperty(*, asgs=None, capacity_monitoring_approach=None, target_percent=None, timeout_minutes=None, ungraceful=None)
Bases:
objectConfiguration for increasing the capacity of Amazon EC2 Auto Scaling groups during a Region switch.
- Parameters:
asgs (
Union[IResolvable,Sequence[Union[IResolvable,AsgProperty,Dict[str,Any]]],None]) – The EC2 Auto Scaling groups for the configuration.capacity_monitoring_approach (
Optional[str]) – The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.target_percent (
Union[int,float,None]) – The target percentage that you specify for EC2 Auto Scaling groups. Default: - 100timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60ungraceful (
Union[IResolvable,Ec2UngracefulProperty,Dict[str,Any],None]) – The settings for ungraceful execution.
- See:
- 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 ec2_asg_capacity_increase_configuration_property = 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 ) )
Attributes
- asgs
The EC2 Auto Scaling groups for the configuration.
- capacity_monitoring_approach
The monitoring approach that you specify EC2 Auto Scaling groups for the configuration.
- target_percent
The target percentage that you specify for EC2 Auto Scaling groups.
- timeout_minutes
The timeout value specified for the configuration.
- ungraceful
The settings for ungraceful execution.
Ec2UngracefulProperty
- class CfnPlanPropsMixin.Ec2UngracefulProperty(*, minimum_success_percentage=None)
Bases:
objectConfiguration for handling failures when performing operations on EC2 resources.
- Parameters:
minimum_success_percentage (
Union[int,float,None]) – The minimum success percentage that you specify for EC2 Auto Scaling groups.- See:
- 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 ec2_ungraceful_property = arcregionswitch_mixins.CfnPlanPropsMixin.Ec2UngracefulProperty( minimum_success_percentage=123 )
Attributes
- minimum_success_percentage
The minimum success percentage that you specify for EC2 Auto Scaling groups.
EcsCapacityIncreaseConfigurationProperty
- class CfnPlanPropsMixin.EcsCapacityIncreaseConfigurationProperty(*, capacity_monitoring_approach=None, services=None, target_percent=None, timeout_minutes=None, ungraceful=None)
Bases:
objectThe configuration for an AWS ECS capacity increase.
- Parameters:
capacity_monitoring_approach (
Optional[str]) – The monitoring approach specified for the configuration, for example,Most_Recent.services (
Union[IResolvable,Sequence[Union[IResolvable,ServiceProperty,Dict[str,Any]]],None]) – The services specified for the configuration.target_percent (
Union[int,float,None]) – The target percentage specified for the configuration. Default: - 100timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60ungraceful (
Union[IResolvable,EcsUngracefulProperty,Dict[str,Any],None]) – The settings for ungraceful execution.
- See:
- 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 ecs_capacity_increase_configuration_property = 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 ) )
Attributes
- capacity_monitoring_approach
The monitoring approach specified for the configuration, for example,
Most_Recent.
- services
The services specified for the configuration.
- target_percent
The target percentage specified for the configuration.
- timeout_minutes
The timeout value specified for the configuration.
- ungraceful
The settings for ungraceful execution.
EcsUngracefulProperty
- class CfnPlanPropsMixin.EcsUngracefulProperty(*, minimum_success_percentage=None)
Bases:
objectThe settings for ungraceful execution.
- Parameters:
minimum_success_percentage (
Union[int,float,None]) – The minimum success percentage specified for the configuration.- See:
- 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 ecs_ungraceful_property = arcregionswitch_mixins.CfnPlanPropsMixin.EcsUngracefulProperty( minimum_success_percentage=123 )
Attributes
- minimum_success_percentage
The minimum success percentage specified for the configuration.
EksClusterProperty
- class CfnPlanPropsMixin.EksClusterProperty(*, cluster_arn=None, cross_account_role=None, external_id=None)
Bases:
objectThe AWS EKS cluster execution block configuration.
- Parameters:
cluster_arn (
Optional[str]) – The Amazon Resource Name (ARN) of an AWS EKS cluster.cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.
- See:
- 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 eks_cluster_property = arcregionswitch_mixins.CfnPlanPropsMixin.EksClusterProperty( cluster_arn="clusterArn", cross_account_role="crossAccountRole", external_id="externalId" )
Attributes
- cluster_arn
The Amazon Resource Name (ARN) of an AWS EKS cluster.
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
EksResourceScalingConfigurationProperty
- class CfnPlanPropsMixin.EksResourceScalingConfigurationProperty(*, capacity_monitoring_approach=None, eks_clusters=None, kubernetes_resource_type=None, scaling_resources=None, target_percent=None, timeout_minutes=None, ungraceful=None)
Bases:
objectThe AWS EKS resource scaling configuration.
- Parameters:
capacity_monitoring_approach (
Optional[str]) – The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.eks_clusters (
Union[IResolvable,Sequence[Union[IResolvable,EksClusterProperty,Dict[str,Any]]],None]) – The clusters for the configuration.kubernetes_resource_type (
Union[IResolvable,KubernetesResourceTypeProperty,Dict[str,Any],None]) – The Kubernetes resource type for the configuration.scaling_resources (
Union[IResolvable,Sequence[Union[IResolvable,Mapping[str,Union[IResolvable,Mapping[str,Union[IResolvable,KubernetesScalingResourceProperty,Dict[str,Any]]]]]]],None]) – The scaling resources for the configuration.target_percent (
Union[int,float,None]) – The target percentage for the configuration. Default: - 100timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60ungraceful (
Union[IResolvable,EksResourceScalingUngracefulProperty,Dict[str,Any],None]) – The settings for ungraceful execution.
- See:
- 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 eks_resource_scaling_configuration_property = 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 ) )
Attributes
- capacity_monitoring_approach
The monitoring approach for the configuration, that is, whether it was sampled in the last 24 hours or autoscaled in the last 24 hours.
- eks_clusters
The clusters for the configuration.
- kubernetes_resource_type
The Kubernetes resource type for the configuration.
- scaling_resources
The scaling resources for the configuration.
- target_percent
The target percentage for the configuration.
- timeout_minutes
The timeout value specified for the configuration.
- ungraceful
The settings for ungraceful execution.
EksResourceScalingUngracefulProperty
- class CfnPlanPropsMixin.EksResourceScalingUngracefulProperty(*, minimum_success_percentage=None)
Bases:
objectThe ungraceful settings for AWS EKS resource scaling.
- Parameters:
minimum_success_percentage (
Union[int,float,None]) – The minimum success percentage for the configuration.- See:
- 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 eks_resource_scaling_ungraceful_property = arcregionswitch_mixins.CfnPlanPropsMixin.EksResourceScalingUngracefulProperty( minimum_success_percentage=123 )
Attributes
- minimum_success_percentage
The minimum success percentage for the configuration.
ExecutionApprovalConfigurationProperty
- class CfnPlanPropsMixin.ExecutionApprovalConfigurationProperty(*, approval_role=None, timeout_minutes=None)
Bases:
objectConfiguration for approval steps in a Region switch plan execution.
Approval steps require manual intervention before the execution can proceed.
- Parameters:
approval_role (
Optional[str]) – The IAM approval role for the configuration.timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60
- See:
- 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 execution_approval_configuration_property = arcregionswitch_mixins.CfnPlanPropsMixin.ExecutionApprovalConfigurationProperty( approval_role="approvalRole", timeout_minutes=123 )
Attributes
- approval_role
The IAM approval role for the configuration.
- timeout_minutes
The timeout value specified for the configuration.
ExecutionBlockConfigurationProperty
- class CfnPlanPropsMixin.ExecutionBlockConfigurationProperty(*, arc_routing_control_config=None, custom_action_lambda_config=None, ec2_asg_capacity_increase_config=None, ecs_capacity_increase_config=None, eks_resource_scaling_config=None, execution_approval_config=None, global_aurora_config=None, parallel_config=None, region_switch_plan_config=None, route53_health_check_config=None)
Bases:
objectExecution block configurations for a workflow in a Region switch plan.
An execution block represents a specific type of action to perform during a Region switch.
- Parameters:
arc_routing_control_config (
Union[IResolvable,ArcRoutingControlConfigurationProperty,Dict[str,Any],None]) – An ARC routing control execution block.custom_action_lambda_config (
Union[IResolvable,CustomActionLambdaConfigurationProperty,Dict[str,Any],None]) – An AWS Lambda execution block.ec2_asg_capacity_increase_config (
Union[IResolvable,Ec2AsgCapacityIncreaseConfigurationProperty,Dict[str,Any],None]) – An EC2 Auto Scaling group execution block.ecs_capacity_increase_config (
Union[IResolvable,EcsCapacityIncreaseConfigurationProperty,Dict[str,Any],None]) – The capacity increase specified for the configuration.eks_resource_scaling_config (
Union[IResolvable,EksResourceScalingConfigurationProperty,Dict[str,Any],None]) – An AWS EKS resource scaling execution block.execution_approval_config (
Union[IResolvable,ExecutionApprovalConfigurationProperty,Dict[str,Any],None]) – A manual approval execution block.global_aurora_config (
Union[IResolvable,GlobalAuroraConfigurationProperty,Dict[str,Any],None]) – An Aurora Global Database execution block.parallel_config (
Union[IResolvable,ParallelExecutionBlockConfigurationProperty,Dict[str,Any],None]) – A parallel configuration execution block.region_switch_plan_config (
Union[IResolvable,RegionSwitchPlanConfigurationProperty,Dict[str,Any],None]) – A Region switch plan execution block.route53_health_check_config (
Union[IResolvable,Route53HealthCheckConfigurationProperty,Dict[str,Any],None]) – The Amazon Route 53 health check configuration.
- See:
- 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 # execution_block_configuration_property_: arcregionswitch_mixins.CfnPlanPropsMixin.ExecutionBlockConfigurationProperty execution_block_configuration_property = 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=[arcregionswitch_mixins.CfnPlanPropsMixin.StepProperty( description="description", execution_block_configuration=execution_block_configuration_property_, execution_block_type="executionBlockType", name="name" )] ), 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 ) )
Attributes
- arc_routing_control_config
An ARC routing control execution block.
- custom_action_lambda_config
An AWS Lambda execution block.
- ec2_asg_capacity_increase_config
An EC2 Auto Scaling group execution block.
- ecs_capacity_increase_config
The capacity increase specified for the configuration.
- eks_resource_scaling_config
An AWS EKS resource scaling execution block.
- execution_approval_config
A manual approval execution block.
- global_aurora_config
An Aurora Global Database execution block.
- parallel_config
A parallel configuration execution block.
- region_switch_plan_config
A Region switch plan execution block.
- route53_health_check_config
The Amazon Route 53 health check configuration.
GlobalAuroraConfigurationProperty
- class CfnPlanPropsMixin.GlobalAuroraConfigurationProperty(*, behavior=None, cross_account_role=None, database_cluster_arns=None, external_id=None, global_cluster_identifier=None, timeout_minutes=None, ungraceful=None)
Bases:
objectConfiguration for Amazon Aurora global databases used in a Region switch plan.
- Parameters:
behavior (
Optional[str]) – The behavior for a global database, that is, only allow switchover or also allow failover.cross_account_role (
Optional[str]) – The cross account role for the configuration.database_cluster_arns (
Optional[Sequence[str]]) – The database cluster Amazon Resource Names (ARNs) for a global database.external_id (
Optional[str]) – The external ID (secret key) for the configuration.global_cluster_identifier (
Optional[str]) – The global cluster identifier for a global database.timeout_minutes (
Union[int,float,None]) – The timeout value specified for the configuration. Default: - 60ungraceful (
Union[IResolvable,GlobalAuroraUngracefulProperty,Dict[str,Any],None]) – The settings for ungraceful execution.
- See:
- 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 global_aurora_configuration_property = 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" ) )
Attributes
- behavior
The behavior for a global database, that is, only allow switchover or also allow failover.
- cross_account_role
The cross account role for the configuration.
- database_cluster_arns
The database cluster Amazon Resource Names (ARNs) for a global database.
- external_id
The external ID (secret key) for the configuration.
- global_cluster_identifier
The global cluster identifier for a global database.
- timeout_minutes
The timeout value specified for the configuration.
- ungraceful
The settings for ungraceful execution.
GlobalAuroraUngracefulProperty
- class CfnPlanPropsMixin.GlobalAuroraUngracefulProperty(*, ungraceful=None)
Bases:
objectConfiguration for handling failures when performing operations on Aurora global databases.
- Parameters:
ungraceful (
Optional[str]) – The settings for ungraceful execution.- See:
- 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 global_aurora_ungraceful_property = arcregionswitch_mixins.CfnPlanPropsMixin.GlobalAuroraUngracefulProperty( ungraceful="ungraceful" )
Attributes
- ungraceful
The settings for ungraceful execution.
HealthCheckStateProperty
- class CfnPlanPropsMixin.HealthCheckStateProperty(*, health_check_id=None, region=None)
Bases:
object- Parameters:
health_check_id (
Optional[str])region (
Optional[str])
- See:
- 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 health_check_state_property = arcregionswitch_mixins.CfnPlanPropsMixin.HealthCheckStateProperty( health_check_id="healthCheckId", region="region" )
Attributes
- health_check_id
-
- Type:
see
KubernetesResourceTypeProperty
- class CfnPlanPropsMixin.KubernetesResourceTypeProperty(*, api_version=None, kind=None)
Bases:
objectDefines the type of Kubernetes resource to scale in an Amazon EKS cluster.
- Parameters:
api_version (
Optional[str]) – The API version type for the Kubernetes resource.kind (
Optional[str]) – The kind for the Kubernetes resource.
- See:
- 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 kubernetes_resource_type_property = arcregionswitch_mixins.CfnPlanPropsMixin.KubernetesResourceTypeProperty( api_version="apiVersion", kind="kind" )
Attributes
- api_version
The API version type for the Kubernetes resource.
- kind
The kind for the Kubernetes resource.
KubernetesScalingResourceProperty
- class CfnPlanPropsMixin.KubernetesScalingResourceProperty(*, hpa_name=None, name=None, namespace=None)
Bases:
objectDefines a Kubernetes resource to scale in an Amazon EKS cluster.
- Parameters:
hpa_name (
Optional[str]) – The hpaname for the Kubernetes resource.name (
Optional[str]) – The name for the Kubernetes resource.namespace (
Optional[str]) – The namespace for the Kubernetes resource.
- See:
- 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 kubernetes_scaling_resource_property = arcregionswitch_mixins.CfnPlanPropsMixin.KubernetesScalingResourceProperty( hpa_name="hpaName", name="name", namespace="namespace" )
Attributes
- hpa_name
The hpaname for the Kubernetes resource.
- name
The name for the Kubernetes resource.
- namespace
The namespace for the Kubernetes resource.
LambdaUngracefulProperty
- class CfnPlanPropsMixin.LambdaUngracefulProperty(*, behavior=None)
Bases:
objectConfiguration for handling failures when invoking Lambda functions.
- Parameters:
behavior (
Optional[str]) – The ungraceful behavior for a Lambda function, which must be set toskip.- See:
- 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 lambda_ungraceful_property = arcregionswitch_mixins.CfnPlanPropsMixin.LambdaUngracefulProperty( behavior="behavior" )
Attributes
- behavior
The ungraceful behavior for a Lambda function, which must be set to
skip.
LambdasProperty
- class CfnPlanPropsMixin.LambdasProperty(*, arn=None, cross_account_role=None, external_id=None)
Bases:
objectConfiguration for AWS Lambda functions used in a Region switch plan.
- Parameters:
arn (
Optional[str]) – The Amazon Resource Name (ARN) of the Lambda function.cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.
- See:
- 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 lambdas_property = arcregionswitch_mixins.CfnPlanPropsMixin.LambdasProperty( arn="arn", cross_account_role="crossAccountRole", external_id="externalId" )
Attributes
- arn
The Amazon Resource Name (ARN) of the Lambda function.
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
ParallelExecutionBlockConfigurationProperty
- class CfnPlanPropsMixin.ParallelExecutionBlockConfigurationProperty(*, steps=None)
Bases:
objectConfiguration for steps that should be executed in parallel during a Region switch.
- Parameters:
steps (
Union[IResolvable,Sequence[Union[IResolvable,StepProperty,Dict[str,Any]]],None]) – The steps for a parallel execution block.- See:
- 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 # parallel_execution_block_configuration_property_: arcregionswitch_mixins.CfnPlanPropsMixin.ParallelExecutionBlockConfigurationProperty parallel_execution_block_configuration_property = arcregionswitch_mixins.CfnPlanPropsMixin.ParallelExecutionBlockConfigurationProperty( 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=parallel_execution_block_configuration_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" )] )
Attributes
- steps
The steps for a parallel execution block.
RegionSwitchPlanConfigurationProperty
- class CfnPlanPropsMixin.RegionSwitchPlanConfigurationProperty(*, arn=None, cross_account_role=None, external_id=None)
Bases:
objectConfiguration for nested Region switch plans.
This allows one Region switch plan to trigger another plan as part of its execution.
- Parameters:
arn (
Optional[str]) – The Amazon Resource Name (ARN) of the plan configuration.cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.
- See:
- 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 region_switch_plan_configuration_property = arcregionswitch_mixins.CfnPlanPropsMixin.RegionSwitchPlanConfigurationProperty( arn="arn", cross_account_role="crossAccountRole", external_id="externalId" )
Attributes
- arn
The Amazon Resource Name (ARN) of the plan configuration.
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
Route53HealthCheckConfigurationProperty
- class CfnPlanPropsMixin.Route53HealthCheckConfigurationProperty(*, cross_account_role=None, external_id=None, hosted_zone_id=None, record_name=None, record_sets=None, timeout_minutes=None)
Bases:
objectThe Amazon Route 53 health check configuration.
- Parameters:
cross_account_role (
Optional[str]) – The cross account role for the configuration.external_id (
Optional[str]) – The external ID (secret key) for the configuration.hosted_zone_id (
Optional[str]) – The Amazon Route 53 health check configuration hosted zone ID.record_name (
Optional[str]) – The Amazon Route 53 health check configuration record name.record_sets (
Union[IResolvable,Sequence[Union[IResolvable,Route53ResourceRecordSetProperty,Dict[str,Any]]],None]) – The Amazon Route 53 health check configuration record sets.timeout_minutes (
Union[int,float,None]) – The Amazon Route 53 health check configuration time out (in minutes). Default: - 60
- See:
- 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 route53_health_check_configuration_property = 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 )
Attributes
- cross_account_role
The cross account role for the configuration.
- external_id
The external ID (secret key) for the configuration.
- hosted_zone_id
The Amazon Route 53 health check configuration hosted zone ID.
- record_name
The Amazon Route 53 health check configuration record name.
- record_sets
The Amazon Route 53 health check configuration record sets.
- timeout_minutes
The Amazon Route 53 health check configuration time out (in minutes).
Route53HealthChecksProperty
- class CfnPlanPropsMixin.Route53HealthChecksProperty(*, health_check_ids=None, hosted_zone_ids=None, record_names=None, regions=None)
Bases:
object- Parameters:
health_check_ids (
Optional[Sequence[str]])hosted_zone_ids (
Optional[Sequence[str]])record_names (
Optional[Sequence[str]])regions (
Optional[Sequence[str]])
- See:
- 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 route53_health_checks_property = arcregionswitch_mixins.CfnPlanPropsMixin.Route53HealthChecksProperty( health_check_ids=["healthCheckIds"], hosted_zone_ids=["hostedZoneIds"], record_names=["recordNames"], regions=["regions"] )
Attributes
- health_check_ids
-
- Type:
see
- hosted_zone_ids
-
- Type:
see
- record_names
-
- Type:
see
Route53ResourceRecordSetProperty
- class CfnPlanPropsMixin.Route53ResourceRecordSetProperty(*, record_set_identifier=None, region=None)
Bases:
objectThe Amazon Route 53 record set.
- Parameters:
record_set_identifier (
Optional[str]) – The Amazon Route 53 record set identifier.region (
Optional[str]) – The Amazon Route 53 record set Region.
- See:
- 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 route53_resource_record_set_property = arcregionswitch_mixins.CfnPlanPropsMixin.Route53ResourceRecordSetProperty( record_set_identifier="recordSetIdentifier", region="region" )
Attributes
- record_set_identifier
The Amazon Route 53 record set identifier.
- region
The Amazon Route 53 record set Region.
ServiceProperty
- class CfnPlanPropsMixin.ServiceProperty(*, cluster_arn=None, cross_account_role=None, external_id=None, service_arn=None)
Bases:
objectThe service for a cross account role.
- Parameters:
cluster_arn (
Optional[str]) – The cluster Amazon Resource Name (ARN) for a service.cross_account_role (
Optional[str]) – The cross account role for a service.external_id (
Optional[str]) – The external ID (secret key) for the service.service_arn (
Optional[str]) – The Amazon Resource Name (ARN) for a service.
- See:
- 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 service_property = arcregionswitch_mixins.CfnPlanPropsMixin.ServiceProperty( cluster_arn="clusterArn", cross_account_role="crossAccountRole", external_id="externalId", service_arn="serviceArn" )
Attributes
- cluster_arn
The cluster Amazon Resource Name (ARN) for a service.
- cross_account_role
The cross account role for a service.
- external_id
The external ID (secret key) for the service.
- service_arn
The Amazon Resource Name (ARN) for a service.
StepProperty
- class CfnPlanPropsMixin.StepProperty(*, description=None, execution_block_configuration=None, execution_block_type=None, name=None)
Bases:
objectRepresents a step in a Region switch plan workflow.
Each step performs a specific action during the Region switch process.
- Parameters:
description (
Optional[str]) – The description of a step in a workflow.execution_block_configuration (
Union[IResolvable,ExecutionBlockConfigurationProperty,Dict[str,Any],None]) – The configuration for an execution block in a workflow.execution_block_type (
Optional[str]) – The type of an execution block in a workflow.name (
Optional[str]) – The name of a step in a workflow.
- See:
- 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 step_property = 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" )
Attributes
- description
The description of a step in a workflow.
- execution_block_configuration
The configuration for an execution block in a workflow.
- execution_block_type
The type of an execution block in a workflow.
- name
The name of a step in a workflow.
TriggerConditionProperty
- class CfnPlanPropsMixin.TriggerConditionProperty(*, associated_alarm_name=None, condition=None)
Bases:
objectDefines a condition that must be met for a trigger to fire.
- Parameters:
associated_alarm_name (
Optional[str]) – The name of the CloudWatch alarm associated with the condition.condition (
Optional[str]) – The condition that must be met. Valid values include ALARM and OK.
- See:
- 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 trigger_condition_property = arcregionswitch_mixins.CfnPlanPropsMixin.TriggerConditionProperty( associated_alarm_name="associatedAlarmName", condition="condition" )
Attributes
- associated_alarm_name
The name of the CloudWatch alarm associated with the condition.
- condition
The condition that must be met.
Valid values include ALARM and OK.
TriggerProperty
- class CfnPlanPropsMixin.TriggerProperty(*, action=None, conditions=None, description=None, min_delay_minutes_between_executions=None, target_region=None)
Bases:
objectDefines a condition that can automatically trigger the execution of a Region switch plan.
- Parameters:
action (
Optional[str]) – The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.conditions (
Union[IResolvable,Sequence[Union[IResolvable,TriggerConditionProperty,Dict[str,Any]]],None]) – The conditions that must be met for the trigger to fire.description (
Optional[str]) – The description for a trigger.min_delay_minutes_between_executions (
Union[int,float,None]) – The minimum time, in minutes, that must elapse between automatic executions of the plan.target_region (
Optional[str]) – The AWS Region for a trigger.
- See:
- 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 trigger_property = 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" )
Attributes
- action
The action to perform when the trigger fires.
Valid values include ACTIVATE and DEACTIVATE.
- conditions
The conditions that must be met for the trigger to fire.
- description
The description for a trigger.
- min_delay_minutes_between_executions
The minimum time, in minutes, that must elapse between automatic executions of the plan.
- target_region
The AWS Region for a trigger.
WorkflowProperty
- class CfnPlanPropsMixin.WorkflowProperty(*, steps=None, workflow_description=None, workflow_target_action=None, workflow_target_region=None)
Bases:
objectRepresents a workflow in a Region switch plan.
A workflow defines a sequence of steps to execute during a Region switch.
- Parameters:
steps (
Union[IResolvable,Sequence[Union[IResolvable,StepProperty,Dict[str,Any]]],None]) – The steps that make up the workflow.workflow_description (
Optional[str]) – The description of the workflow.workflow_target_action (
Optional[str]) – The action that the workflow performs. Valid values include ACTIVATE and DEACTIVATE.workflow_target_region (
Optional[str]) – The AWS Region that the workflow targets.
- See:
- 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 workflow_property = 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
- steps
The steps that make up the workflow.
- workflow_description
The description of the workflow.
- workflow_target_action
The action that the workflow performs.
Valid values include ACTIVATE and DEACTIVATE.
- workflow_target_region
The AWS Region that the workflow targets.